OpenStack v3.12.1, Mar 23 23

openstack.networking.QosPolicy

Manages a V2 Neutron QoS policy resource within OpenStack.

Example Usage

Create a QoS Policy

using System.Collections.Generic;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var qosPolicy1 = new OpenStack.Networking.QosPolicy("qosPolicy1", new()
    {
        Description = "bw_limit",
    });

});

package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v3/go/openstack/networking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networking.NewQosPolicy(ctx, "qosPolicy1", &networking.QosPolicyArgs{
			Description: pulumi.String("bw_limit"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.networking.QosPolicy;
import com.pulumi.openstack.networking.QosPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var qosPolicy1 = new QosPolicy("qosPolicy1", QosPolicyArgs.builder()        
            .description("bw_limit")
            .build());

    }
}

import pulumi
import pulumi_openstack as openstack

qos_policy1 = openstack.networking.QosPolicy("qosPolicy1", description="bw_limit")

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const qosPolicy1 = new openstack.networking.QosPolicy("qosPolicy1", {description: "bw_limit"});

resources:
  qosPolicy1:
    type: openstack:networking:QosPolicy
    properties:
      description: bw_limit

Create QosPolicy Resource

new QosPolicy(name: string, args?: QosPolicyArgs, opts?: CustomResourceOptions);

@overload
def QosPolicy(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              description: Optional[str] = None,
              is_default: Optional[bool] = None,
              name: Optional[str] = None,
              project_id: Optional[str] = None,
              region: Optional[str] = None,
              shared: Optional[bool] = None,
              tags: Optional[Sequence[str]] = None,
              value_specs: Optional[Mapping[str, Any]] = None)
@overload
def QosPolicy(resource_name: str,
              args: Optional[QosPolicyArgs] = None,
              opts: Optional[ResourceOptions] = None)

func NewQosPolicy(ctx *Context, name string, args *QosPolicyArgs, opts ...ResourceOption) (*QosPolicy, error)

public QosPolicy(string name, QosPolicyArgs? args = null, CustomResourceOptions? opts = null)

public QosPolicy(String name, QosPolicyArgs args)
public QosPolicy(String name, QosPolicyArgs args, CustomResourceOptions options)

type: openstack:networking:QosPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args QosPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args QosPolicyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args QosPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args QosPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args QosPolicyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

QosPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The QosPolicy resource accepts the following input properties:

Description string: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
IsDefault bool: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
Name string: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
ProjectId string: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
Shared bool: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
Tags List<string>: A set of string tags for the QoS policy.
ValueSpecs Dictionary<string, object>: Map of additional options.

Description string: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
IsDefault bool: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
Name string: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
ProjectId string: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
Shared bool: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
Tags []string: A set of string tags for the QoS policy.
ValueSpecs map[string]interface{}: Map of additional options.

description String: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
isDefault Boolean: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name String: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
projectId String: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region String: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
shared Boolean: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags List<String>: A set of string tags for the QoS policy.
valueSpecs Map<String,Object>: Map of additional options.

description string: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
isDefault boolean: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name string: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
projectId string: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
shared boolean: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags string[]: A set of string tags for the QoS policy.
valueSpecs {[key: string]: any}: Map of additional options.

description str: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
is_default bool: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name str: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
project_id str: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
shared bool: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags Sequence[str]: A set of string tags for the QoS policy.
value_specs Mapping[str, Any]: Map of additional options.

description String: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
isDefault Boolean: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name String: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
projectId String: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region String: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
shared Boolean: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags List<String>: A set of string tags for the QoS policy.
valueSpecs Map<Any>: Map of additional options.

Outputs

All input properties are implicitly available as output properties. Additionally, the QosPolicy resource produces the following output properties:

AllTags List<string>: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
CreatedAt string: The time at which QoS policy was created.
Id string: The provider-assigned unique ID for this managed resource.
RevisionNumber int: The revision number of the QoS policy.
UpdatedAt string: The time at which QoS policy was created.

AllTags []string: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
CreatedAt string: The time at which QoS policy was created.
Id string: The provider-assigned unique ID for this managed resource.
RevisionNumber int: The revision number of the QoS policy.
UpdatedAt string: The time at which QoS policy was created.

allTags List<String>: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
createdAt String: The time at which QoS policy was created.
id String: The provider-assigned unique ID for this managed resource.
revisionNumber Integer: The revision number of the QoS policy.
updatedAt String: The time at which QoS policy was created.

allTags string[]: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
createdAt string: The time at which QoS policy was created.
id string: The provider-assigned unique ID for this managed resource.
revisionNumber number: The revision number of the QoS policy.
updatedAt string: The time at which QoS policy was created.

all_tags Sequence[str]: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
created_at str: The time at which QoS policy was created.
id str: The provider-assigned unique ID for this managed resource.
revision_number int: The revision number of the QoS policy.
updated_at str: The time at which QoS policy was created.

allTags List<String>: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
createdAt String: The time at which QoS policy was created.
id String: The provider-assigned unique ID for this managed resource.
revisionNumber Number: The revision number of the QoS policy.
updatedAt String: The time at which QoS policy was created.

Look up Existing QosPolicy Resource

Get an existing QosPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: QosPolicyState, opts?: CustomResourceOptions): QosPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        all_tags: Optional[Sequence[str]] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        is_default: Optional[bool] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        revision_number: Optional[int] = None,
        shared: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None,
        value_specs: Optional[Mapping[str, Any]] = None) -> QosPolicy

func GetQosPolicy(ctx *Context, name string, id IDInput, state *QosPolicyState, opts ...ResourceOption) (*QosPolicy, error)

public static QosPolicy Get(string name, Input<string> id, QosPolicyState? state, CustomResourceOptions? opts = null)

public static QosPolicy get(String name, Output<String> id, QosPolicyState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllTags List<string>: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
CreatedAt string: The time at which QoS policy was created.
Description string: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
IsDefault bool: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
Name string: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
ProjectId string: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
RevisionNumber int: The revision number of the QoS policy.
Shared bool: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
Tags List<string>: A set of string tags for the QoS policy.
UpdatedAt string: The time at which QoS policy was created.
ValueSpecs Dictionary<string, object>: Map of additional options.

AllTags []string: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
CreatedAt string: The time at which QoS policy was created.
Description string: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
IsDefault bool: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
Name string: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
ProjectId string: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
RevisionNumber int: The revision number of the QoS policy.
Shared bool: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
Tags []string: A set of string tags for the QoS policy.
UpdatedAt string: The time at which QoS policy was created.
ValueSpecs map[string]interface{}: Map of additional options.

allTags List<String>: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
createdAt String: The time at which QoS policy was created.
description String: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
isDefault Boolean: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name String: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
projectId String: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region String: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
revisionNumber Integer: The revision number of the QoS policy.
shared Boolean: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags List<String>: A set of string tags for the QoS policy.
updatedAt String: The time at which QoS policy was created.
valueSpecs Map<String,Object>: Map of additional options.

allTags string[]: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
createdAt string: The time at which QoS policy was created.
description string: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
isDefault boolean: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name string: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
projectId string: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
revisionNumber number: The revision number of the QoS policy.
shared boolean: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags string[]: A set of string tags for the QoS policy.
updatedAt string: The time at which QoS policy was created.
valueSpecs {[key: string]: any}: Map of additional options.

all_tags Sequence[str]: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
created_at str: The time at which QoS policy was created.
description str: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
is_default bool: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name str: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
project_id str: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
revision_number int: The revision number of the QoS policy.
shared bool: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags Sequence[str]: A set of string tags for the QoS policy.
updated_at str: The time at which QoS policy was created.
value_specs Mapping[str, Any]: Map of additional options.

allTags List<String>: The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
createdAt String: The time at which QoS policy was created.
description String: The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
isDefault Boolean: Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name String: The name of the QoS policy. Changing this updates the name of the existing QoS policy.
projectId String: The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region String: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the region argument of the provider is used. Changing this creates a new QoS policy.
revisionNumber Number: The revision number of the QoS policy.
shared Boolean: Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags List<String>: A set of string tags for the QoS policy.
updatedAt String: The time at which QoS policy was created.
valueSpecs Map<Any>: Map of additional options.

Import

QoS Policies can be imported using the id, e.g.

 $ pulumi import openstack:networking/qosPolicy:QosPolicy qos_policy_1 d6ae28ce-fcb5-4180-aa62-d260a27e09ae

Package Details

Repository: OpenStack pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.