1. Docs
  2. Reference
  3. API
  4. @pulumi/openstack
  5. networking

Module networking

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-openstack repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-openstack repo.

Resources

Functions

Others

Resources

Resource AddressScope

class AddressScope extends CustomResource

Manages a V2 Neutron addressscope resource within OpenStack.

Example Usage

Create an Address-scope
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const addressscope1 = new openstack.networking.AddressScope("addressscope1", {
    ipVersion: 6,
});
Create a Subnet Pool from an Address-scope
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const addressscope1 = new openstack.networking.AddressScope("addressscope1", {
    ipVersion: 6,
});
const subnetpool1 = new openstack.networking.SubnetPool("subnetpool1", {
    addressScopeId: addressscope1.id,
    prefixes: [
        "fdf7:b13d:dead:beef::/64",
        "fd65:86cc:a334:39b7::/64",
    ],
});

constructor

new AddressScope(name: string, args?: AddressScopeArgs, opts?: pulumi.CustomResourceOptions)

Create a AddressScope resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AddressScopeState, opts?: pulumi.CustomResourceOptions): AddressScope

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AddressScope

Returns true if the given object is an instance of AddressScope. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipVersion

public ipVersion: pulumi.Output<number | undefined>;

IP version, either 4 (default) or 6. Changing this creates a new address-scope.

property name

public name: pulumi.Output<string>;

The name of the address-scope. Changing this updates the name of the existing address-scope.

property projectId

public projectId: pulumi.Output<string>;

The owner of the address-scope. Required if admin wants to create a address-scope for another project. Changing this creates a new address-scope.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron address-scope. If omitted, the region argument of the provider is used. Changing this creates a new address-scope.

property shared

public shared: pulumi.Output<boolean>;

Indicates whether this address-scope is shared across all projects. Changing this updates the shared status of the existing address-scope.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource FloatingIp

class FloatingIp extends CustomResource

Manages a V2 floating IP resource within OpenStack Neutron (networking) that can be used for load balancers. These are similar to Nova (compute) floating IP resources, but only compute floating IPs can be used with compute instances.

Example Usage

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

const floatip1 = new openstack.networking.FloatingIp("floatip1", {
    pool: "public",
});

constructor

new FloatingIp(name: string, args: FloatingIpArgs, opts?: pulumi.CustomResourceOptions)

Create a FloatingIp resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FloatingIpState, opts?: pulumi.CustomResourceOptions): FloatingIp

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FloatingIp

Returns true if the given object is an instance of FloatingIp. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property address

public address: pulumi.Output<string>;

The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.

property allTags

public allTags: pulumi.Output<string[]>;

The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.

property description

public description: pulumi.Output<string | undefined>;

Human-readable description for the floating IP.

property dnsDomain

public dnsDomain: pulumi.Output<string>;

The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.

property dnsName

public dnsName: pulumi.Output<string>;

The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.

property fixedIp

public fixedIp: pulumi.Output<string>;

Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property pool

public pool: pulumi.Output<string>;

The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.

property portId

public portId: pulumi.Output<string>;

ID of an existing port with at least one IP address to associate with this floating IP.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).

property subnetId

public subnetId: pulumi.Output<string | undefined>;

The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.

property tags

public tags: pulumi.Output<string[] | undefined>;

A set of string tags for the floating IP.

property tenantId

public tenantId: pulumi.Output<string>;

The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueSpecs

public valueSpecs: pulumi.Output<{[key: string]: any} | undefined>;

Map of additional options.

Resource FloatingIpAssociate

class FloatingIpAssociate extends CustomResource

Associates a floating IP to a port. This is useful for situations where you have a pre-allocated floating IP or are unable to use the openstack.networking.FloatingIp resource to create a floating IP.

Example Usage

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

const port1 = new openstack.networking.Port("port1", {
    networkId: "a5bbd213-e1d3-49b6-aed1-9df60ea94b9a",
});
const fip1 = new openstack.networking.FloatingIpAssociate("fip1", {
    floatingIp: "1.2.3.4",
    portId: port1.id,
});

constructor

new FloatingIpAssociate(name: string, args: FloatingIpAssociateArgs, opts?: pulumi.CustomResourceOptions)

Create a FloatingIpAssociate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FloatingIpAssociateState, opts?: pulumi.CustomResourceOptions): FloatingIpAssociate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FloatingIpAssociate

Returns true if the given object is an instance of FloatingIpAssociate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fixedIp

public fixedIp: pulumi.Output<string>;

property floatingIp

public floatingIp: pulumi.Output<string>;

IP Address of an existing floating IP.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property portId

public portId: pulumi.Output<string>;

ID of an existing port with at least one IP address to associate with this floating IP.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Network

class Network extends CustomResource

Manages a V2 Neutron network resource within OpenStack.

Example Usage

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

const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const subnet1 = new openstack.networking.Subnet("subnet1", {
    cidr: "192.168.199.0/24",
    ipVersion: 4,
    networkId: network1.id,
});
const secgroup1 = new openstack.compute.SecGroup("secgroup1", {
    description: "a security group",
    rules: [{
        cidr: "0.0.0.0/0",
        fromPort: 22,
        ipProtocol: "tcp",
        toPort: 22,
    }],
});
const port1 = new openstack.networking.Port("port1", {
    adminStateUp: true,
    fixedIps: [{
        ipAddress: "192.168.199.10",
        subnetId: subnet1.id,
    }],
    networkId: network1.id,
    securityGroupIds: [secgroup1.id],
});
const instance1 = new openstack.compute.Instance("instance1", {
    networks: [{
        port: port1.id,
    }],
    securityGroups: [secgroup1.name],
});

constructor

new Network(name: string, args?: NetworkArgs, opts?: pulumi.CustomResourceOptions)

Create a Network resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkState, opts?: pulumi.CustomResourceOptions): Network

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Network

Returns true if the given object is an instance of Network. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property adminStateUp

public adminStateUp: pulumi.Output<boolean>;

The administrative state of the network. Acceptable values are “true” and “false”. Changing this value updates the state of the existing network.

property allTags

public allTags: pulumi.Output<string[]>;

The collection of tags assigned on the network, which have been explicitly and implicitly added.

property availabilityZoneHints

public availabilityZoneHints: pulumi.Output<string[]>;

An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new network.

property description

public description: pulumi.Output<string | undefined>;

Human-readable description of the network. Changing this updates the name of the existing network.

property dnsDomain

public dnsDomain: pulumi.Output<string>;

The network DNS domain. Available, when Neutron DNS extension is enabled. The dnsDomain of a network in conjunction with the dnsName attribute of its ports will be published in an external DNS service when Neutron is configured to integrate with such a service.

property external

public external: pulumi.Output<boolean>;

Specifies whether the network resource has the external routing facility. Valid values are true and false. Defaults to false. Changing this updates the external attribute of the existing network.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property mtu

public mtu: pulumi.Output<number>;

The network MTU. Available for read-only, when Neutron net-mtu extension is enabled. Available for the modification, when Neutron net-mtu-writable extension is enabled.

property name

public name: pulumi.Output<string>;

The name of the network. Changing this updates the name of the existing network.

property portSecurityEnabled

public portSecurityEnabled: pulumi.Output<boolean>;

Whether to explicitly enable or disable port security on the network. Port Security is usually enabled by default, so omitting this argument will usually result in a value of “true”. Setting this explicitly to false will disable port security. Valid values are true and false.

property qosPolicyId

public qosPolicyId: pulumi.Output<string>;

Reference to the associated QoS policy.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron network. If omitted, the region argument of the provider is used. Changing this creates a new network.

property segments

public segments: pulumi.Output<NetworkSegment[] | undefined>;

An array of one or more provider segment objects.

property shared

public shared: pulumi.Output<boolean>;

Specifies whether the network resource can be accessed by any tenant or not. Changing this updates the sharing capabilities of the existing network.

property tags

public tags: pulumi.Output<string[] | undefined>;

A set of string tags for the network.

property tenantId

public tenantId: pulumi.Output<string>;

The owner of the network. Required if admin wants to create a network for another tenant. Changing this creates a new network.

property transparentVlan

public transparentVlan: pulumi.Output<boolean>;

Specifies whether the network resource has the VLAN transparent attribute set. Valid values are true and false. Defaults to false. Changing this updates the transparentVlan attribute of the existing network.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueSpecs

public valueSpecs: pulumi.Output<{[key: string]: any} | undefined>;

Map of additional options.

Resource Port

class Port extends CustomResource

Manages a V2 port resource within OpenStack.

Example Usage

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

const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const port1 = new openstack.networking.Port("port1", {
    adminStateUp: true,
    networkId: network1.id,
});
Port with physical binding information
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const port1 = new openstack.networking.Port("port1", {
    adminStateUp: true,
    binding: {
        hostId: "b080b9cf-46e0-4ce8-ad47-0fd4accc872b",
        profile: `{
  "localLinkInformation": [
    {
      "switchInfo": "info1",
      "portId": "Ethernet3/4",
      "switchId": "12:34:56:78:9A:BC"
    },
    {
      "switchInfo": "info2",
      "portId": "Ethernet3/4",
      "switchId": "12:34:56:78:9A:BD"
    }
  ],
  "vlanType": "allowed"
}
`,
        vnicType: "baremetal",
    },
    deviceId: "cdf70fcf-c161-4f24-9c70-96b3f5a54b71",
    deviceOwner: "baremetal:none",
    networkId: network1.id,
});

Notes

Ports and Instances

There are some notes to consider when connecting Instances to networks using Ports. Please see the openstack.compute.Instance documentation for further documentation.

constructor

new Port(name: string, args: PortArgs, opts?: pulumi.CustomResourceOptions)

Create a Port resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PortState, opts?: pulumi.CustomResourceOptions): Port

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Port

Returns true if the given object is an instance of Port. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property adminStateUp

public adminStateUp: pulumi.Output<boolean>;

Administrative up/down status for the port (must be “true” or “false” if provided). Changing this updates the adminStateUp of an existing port.

property allFixedIps

public allFixedIps: pulumi.Output<string[]>;

The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.

property allSecurityGroupIds

public allSecurityGroupIds: pulumi.Output<string[]>;

The collection of Security Group IDs on the port which have been explicitly and implicitly added.

property allTags

public allTags: pulumi.Output<string[]>;

The collection of tags assigned on the port, which have been explicitly and implicitly added.

property allowedAddressPairs

public allowedAddressPairs: pulumi.Output<PortAllowedAddressPair[] | undefined>;

An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.

property binding

public binding: pulumi.Output<PortBinding>;

The port binding allows to specify binding information for the port. The structure is described below.

property description

public description: pulumi.Output<string | undefined>;

Human-readable description of the floating IP. Changing this updates the description of an existing port.

property deviceId

public deviceId: pulumi.Output<string>;

The ID of the device attached to the port. Changing this creates a new port.

property deviceOwner

public deviceOwner: pulumi.Output<string>;

The device owner of the Port. Changing this creates a new port.

property dnsAssignments

public dnsAssignments: pulumi.Output<{[key: string]: any}[]>;

The list of maps representing port DNS assignments.

property dnsName

public dnsName: pulumi.Output<string>;

The port DNS name. Available, when Neutron DNS extension is enabled.

property extraDhcpOptions

public extraDhcpOptions: pulumi.Output<PortExtraDhcpOption[] | undefined>;

An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times.

property fixedIps

public fixedIps: pulumi.Output<PortFixedIp[] | undefined>;

An array of desired IPs for this port. The structure is described below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property macAddress

public macAddress: pulumi.Output<string>;

The additional MAC address.

property name

public name: pulumi.Output<string>;

Name of the DHCP option.

property networkId

public networkId: pulumi.Output<string>;

The ID of the network to attach the port to. Changing this creates a new port.

property noFixedIp

public noFixedIp: pulumi.Output<boolean | undefined>;

Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.

property noSecurityGroups

public noSecurityGroups: pulumi.Output<boolean | undefined>;

If set to true, then no security groups are applied to the port. If set to false and no securityGroupIds are specified, then the Port will yield to the default behavior of the Networking service, which is to usually apply the “default” security group.

property portSecurityEnabled

public portSecurityEnabled: pulumi.Output<boolean>;

Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of “true”. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.

property qosPolicyId

public qosPolicyId: pulumi.Output<string>;

Reference to the associated QoS policy.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.

property securityGroupIds

public securityGroupIds: pulumi.Output<string[] | undefined>;

A list of security group IDs to apply to the port. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).

property tags

public tags: pulumi.Output<string[] | undefined>;

A set of string tags for the port.

property tenantId

public tenantId: pulumi.Output<string>;

The owner of the Port. Required if admin wants to create a port for another tenant. Changing this creates a new port.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueSpecs

public valueSpecs: pulumi.Output<{[key: string]: any} | undefined>;

Map of additional options.

Resource PortSecGroupAssociate

class PortSecGroupAssociate extends CustomResource

constructor

new PortSecGroupAssociate(name: string, args: PortSecGroupAssociateArgs, opts?: pulumi.CustomResourceOptions)

Create a PortSecGroupAssociate resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PortSecGroupAssociateState, opts?: pulumi.CustomResourceOptions): PortSecGroupAssociate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PortSecGroupAssociate

Returns true if the given object is an instance of PortSecGroupAssociate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allSecurityGroupIds

public allSecurityGroupIds: pulumi.Output<string[]>;

The collection of Security Group IDs on the port which have been explicitly and implicitly added.

property enforce

public enforce: pulumi.Output<boolean | undefined>;

Whether to replace or append the list of security groups, specified in the securityGroupIds. Defaults to false.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property portId

public portId: pulumi.Output<string>;

An UUID of the port to apply security groups to.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to manage a port. If omitted, the region argument of the provider is used. Changing this creates a new resource.

property securityGroupIds

public securityGroupIds: pulumi.Output<string[]>;

A list of security group IDs to apply to the port. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource QosBandwidthLimitRule

class QosBandwidthLimitRule extends CustomResource

Manages a V2 Neutron QoS bandwidth limit rule resource within OpenStack.

Example Usage

Create a QoS Policy with some bandwidth limit rule
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const qosPolicy1 = new openstack.networking.QosPolicy("qosPolicy1", {
    description: "bwLimit",
});
const bwLimitRule1 = new openstack.networking.QosBandwidthLimitRule("bwLimitRule1", {
    direction: "egress",
    maxBurstKbps: 300,
    maxKbps: 3000,
    qosPolicyId: qosPolicy1.id,
});

constructor

new QosBandwidthLimitRule(name: string, args: QosBandwidthLimitRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a QosBandwidthLimitRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QosBandwidthLimitRuleState, opts?: pulumi.CustomResourceOptions): QosBandwidthLimitRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is QosBandwidthLimitRule

Returns true if the given object is an instance of QosBandwidthLimitRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property direction

public direction: pulumi.Output<string | undefined>;

The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS bandwidth limit rule.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maxBurstKbps

public maxBurstKbps: pulumi.Output<number | undefined>;

The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.

property maxKbps

public maxKbps: pulumi.Output<number>;

The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.

property qosPolicyId

public qosPolicyId: pulumi.Output<string>;

The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource QosDscpMarkingRule

class QosDscpMarkingRule extends CustomResource

Manages a V2 Neutron QoS DSCP marking rule resource within OpenStack.

Example Usage

Create a QoS Policy with some DSCP marking rule
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const qosPolicy1 = new openstack.networking.QosPolicy("qosPolicy1", {
    description: "dscpMark",
});
const dscpMarkingRule1 = new openstack.networking.QosDscpMarkingRule("dscpMarkingRule1", {
    dscpMark: 26,
    qosPolicyId: qosPolicy1.id,
});

constructor

new QosDscpMarkingRule(name: string, args: QosDscpMarkingRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a QosDscpMarkingRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QosDscpMarkingRuleState, opts?: pulumi.CustomResourceOptions): QosDscpMarkingRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is QosDscpMarkingRule

Returns true if the given object is an instance of QosDscpMarkingRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dscpMark

public dscpMark: pulumi.Output<number>;

The value of DSCP mark. Changing this updates the DSCP mark value existing QoS DSCP marking rule.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property qosPolicyId

public qosPolicyId: pulumi.Output<string>;

The QoS policy reference. Changing this creates a new QoS DSCP marking rule.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS DSCP marking rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS DSCP marking rule.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource QosMinimumBandwidthRule

class QosMinimumBandwidthRule extends CustomResource

Manages a V2 Neutron QoS minimum bandwidth rule resource within OpenStack.

Example Usage

Create a QoS Policy with some minimum bandwidth rule
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const qosPolicy1 = new openstack.networking.QosPolicy("qosPolicy1", {
    description: "minKbps",
});
const minimumBandwidthRule1 = new openstack.networking.QosMinimumBandwidthRule("minimumBandwidthRule1", {
    minKbps: 200,
    qosPolicyId: qosPolicy1.id,
});

constructor

new QosMinimumBandwidthRule(name: string, args: QosMinimumBandwidthRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a QosMinimumBandwidthRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QosMinimumBandwidthRuleState, opts?: pulumi.CustomResourceOptions): QosMinimumBandwidthRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is QosMinimumBandwidthRule

Returns true if the given object is an instance of QosMinimumBandwidthRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property direction

public direction: pulumi.Output<string | undefined>;

The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS minimum bandwidth rule.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property minKbps

public minKbps: pulumi.Output<number>;

The minimum kilobits per second. Changing this updates the min kbps value of the existing QoS minimum bandwidth rule.

property qosPolicyId

public qosPolicyId: pulumi.Output<string>;

The QoS policy reference. Changing this creates a new QoS minimum bandwidth rule.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS minimum bandwidth rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS minimum bandwidth rule.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource QosPolicy

class QosPolicy extends CustomResource

Manages a V2 Neutron QoS policy resource within OpenStack.

Example Usage

Create a QoS Policy
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

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

constructor

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

Create a QosPolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

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

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is QosPolicy

Returns true if the given object is an instance of QosPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allTags

public allTags: pulumi.Output<string[]>;

The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.

property createdAt

public createdAt: pulumi.Output<string>;

The time at which QoS policy was created.

property description

public description: pulumi.Output<string | undefined>;

The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property isDefault

public isDefault: pulumi.Output<boolean | undefined>;

Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.

property name

public name: pulumi.Output<string>;

The name of the QoS policy. Changing this updates the name of the existing QoS policy.

property projectId

public projectId: pulumi.Output<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.

property region

public region: pulumi.Output<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.

property revisionNumber

public revisionNumber: pulumi.Output<number>;

The revision number of the QoS policy.

property shared

public shared: pulumi.Output<boolean | undefined>;

Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.

property tags

public tags: pulumi.Output<string[] | undefined>;

A set of string tags for the QoS policy.

property updatedAt

public updatedAt: pulumi.Output<string>;

The time at which QoS policy was created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueSpecs

public valueSpecs: pulumi.Output<{[key: string]: any} | undefined>;

Map of additional options.

Resource QuotaV2

class QuotaV2 extends CustomResource

Manages a V2 networking quota resource within OpenStack.

Note: This usually requires admin privileges.

Note: This resource has a no-op deletion so no actual actions will be done against the OpenStack API in case of delete call.

constructor

new QuotaV2(name: string, args: QuotaV2Args, opts?: pulumi.CustomResourceOptions)

Create a QuotaV2 resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QuotaV2State, opts?: pulumi.CustomResourceOptions): QuotaV2

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is QuotaV2

Returns true if the given object is an instance of QuotaV2. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property floatingip

public floatingip: pulumi.Output<number>;

Quota value for floating IPs. Changing this updates the existing quota.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property network

public network: pulumi.Output<number>;

Quota value for networks. Changing this updates the existing quota.

property port

public port: pulumi.Output<number>;

Quota value for ports. Changing this updates the existing quota.

property projectId

public projectId: pulumi.Output<string>;

ID of the project to manage quota. Changing this creates new quota.

property rbacPolicy

public rbacPolicy: pulumi.Output<number>;

Quota value for RBAC policies. Changing this updates the existing quota.

property region

public region: pulumi.Output<string>;

The region in which to create the quota. If omitted, the region argument of the provider is used. Changing this creates new quota.

property router

public router: pulumi.Output<number>;

Quota value for routers. Changing this updates the existing quota.

property securityGroup

public securityGroup: pulumi.Output<number>;

Quota value for security groups. Changing this updates the existing quota.

property securityGroupRule

public securityGroupRule: pulumi.Output<number>;

Quota value for security group rules. Changing this updates the existing quota.

property subnet

public subnet: pulumi.Output<number>;

Quota value for subnets. Changing this updates the existing quota.

property subnetpool

public subnetpool: pulumi.Output<number>;

Quota value for subnetpools. Changing this updates the existing quota.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RbacPolicyV2

class RbacPolicyV2 extends CustomResource

The RBAC policy resource contains functionality for working with Neutron RBAC Policies. Role-Based Access Control (RBAC) policy framework enables both operators and users to grant access to resources for specific projects.

Sharing an object with a specific project is accomplished by creating a policy entry that permits the target project the accessAsShared action on that object.

To make a network available as an external network for specific projects rather than all projects, use the accessAsExternal action. If a network is marked as external during creation, it now implicitly creates a wildcard RBAC policy granting everyone access to preserve previous behavior before this feature was added.

Example Usage

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

const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const rbacPolicy1 = new openstack.networking.RbacPolicyV2("rbacPolicy1", {
    action: "accessAsShared",
    objectId: network1.id,
    objectType: "network",
    targetTenant: "20415a973c9e45d3917f078950644697",
});

constructor

new RbacPolicyV2(name: string, args: RbacPolicyV2Args, opts?: pulumi.CustomResourceOptions)

Create a RbacPolicyV2 resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RbacPolicyV2State, opts?: pulumi.CustomResourceOptions): RbacPolicyV2

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RbacPolicyV2

Returns true if the given object is an instance of RbacPolicyV2. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property action

public action: pulumi.Output<string>;

Action for the RBAC policy. Can either be accessAsExternal or accessAsShared.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property objectId

public objectId: pulumi.Output<string>;

The ID of the objectType resource. An objectType of network returns a network ID and an objectType of qosPolicy returns a QoS ID.

property objectType

public objectType: pulumi.Output<string>;

The type of the object that the RBAC policy affects. Can either be qos-policy or network.

property projectId

public projectId: pulumi.Output<string>;

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

property targetTenant

public targetTenant: pulumi.Output<string>;

The ID of the tenant to which the RBAC policy will be enforced.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Router

class Router extends CustomResource

Manages a V2 router resource within OpenStack.

Example Usage

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

const router1 = new openstack.networking.Router("router1", {
    adminStateUp: true,
    externalNetworkId: "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f",
});

constructor

new Router(name: string, args?: RouterArgs, opts?: pulumi.CustomResourceOptions)

Create a Router resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouterState, opts?: pulumi.CustomResourceOptions): Router

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Router

Returns true if the given object is an instance of Router. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property adminStateUp

public adminStateUp: pulumi.Output<boolean>;

Administrative up/down status for the router (must be “true” or “false” if provided). Changing this updates the adminStateUp of an existing router.

property allTags

public allTags: pulumi.Output<string[]>;

The collection of tags assigned on the router, which have been explicitly and implicitly added.

property availabilityZoneHints

public availabilityZoneHints: pulumi.Output<string[]>;

An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.

property description

public description: pulumi.Output<string | undefined>;

Human-readable description for the router.

property distributed

public distributed: pulumi.Output<boolean>;

Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.

property enableSnat

public enableSnat: pulumi.Output<boolean>;

Enable Source NAT for the router. Valid values are “true” or “false”. An externalNetworkId has to be set in order to set this property. Changing this updates the enableSnat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.

property externalFixedIps

public externalFixedIps: pulumi.Output<RouterExternalFixedIp[]>;

An external fixed IP for the router. This can be repeated. The structure is described below. An externalNetworkId has to be set in order to set this property. Changing this updates the external fixed IPs of the router.

property externalGateway

public externalGateway: pulumi.Output<string>;

The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of an existing router.

property externalNetworkId

public externalNetworkId: pulumi.Output<string>;

The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

A unique name for the router. Changing this updates the name of an existing router.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.

property tags

public tags: pulumi.Output<string[] | undefined>;

A set of string tags for the router.

property tenantId

public tenantId: pulumi.Output<string>;

The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueSpecs

public valueSpecs: pulumi.Output<{[key: string]: any} | undefined>;

Map of additional driver-specific options.

property vendorOptions

public vendorOptions: pulumi.Output<RouterVendorOptions | undefined>;

Map of additional vendor-specific options. Supported options are described below.

Resource RouterInterface

class RouterInterface extends CustomResource

Manages a V2 router interface resource within OpenStack.

Example Usage

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

const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const subnet1 = new openstack.networking.Subnet("subnet1", {
    cidr: "192.168.199.0/24",
    ipVersion: 4,
    networkId: network1.id,
});
const router1 = new openstack.networking.Router("router1", {
    externalNetworkId: "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f",
});
const routerInterface1 = new openstack.networking.RouterInterface("routerInterface1", {
    routerId: router1.id,
    subnetId: subnet1.id,
});

constructor

new RouterInterface(name: string, args: RouterInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a RouterInterface resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouterInterfaceState, opts?: pulumi.CustomResourceOptions): RouterInterface

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RouterInterface

Returns true if the given object is an instance of RouterInterface. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property portId

public portId: pulumi.Output<string>;

ID of the port this interface connects to. Changing this creates a new router interface.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.

property routerId

public routerId: pulumi.Output<string>;

ID of the router this interface belongs to. Changing this creates a new router interface.

property subnetId

public subnetId: pulumi.Output<string>;

ID of the subnet this interface connects to. Changing this creates a new router interface.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RouterRoute

class RouterRoute extends CustomResource

Creates a routing entry on a OpenStack V2 router.

Example Usage

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

const router1 = new openstack.networking.Router("router1", {
    adminStateUp: true,
});
const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const subnet1 = new openstack.networking.Subnet("subnet1", {
    cidr: "192.168.199.0/24",
    ipVersion: 4,
    networkId: network1.id,
});
const int1 = new openstack.networking.RouterInterface("int1", {
    routerId: router1.id,
    subnetId: subnet1.id,
});
const routerRoute1 = new openstack.networking.RouterRoute("routerRoute1", {
    destinationCidr: "10.0.1.0/24",
    nextHop: "192.168.199.254",
    routerId: router1.id,
}, { dependsOn: [int1] });

Notes

The nextHop IP address must be directly reachable from the router at the openstack.networking.RouterRoute resource creation time. You can ensure that by explicitly specifying a dependency on the openstack.networking.RouterInterface resource that connects the next hop to the router, as in the example above.

constructor

new RouterRoute(name: string, args: RouterRouteArgs, opts?: pulumi.CustomResourceOptions)

Create a RouterRoute resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouterRouteState, opts?: pulumi.CustomResourceOptions): RouterRoute

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RouterRoute

Returns true if the given object is an instance of RouterRoute. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property destinationCidr

public destinationCidr: pulumi.Output<string>;

CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property nextHop

public nextHop: pulumi.Output<string>;

IP address of the next hop gateway. Changing this creates a new routing entry.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a router. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

property routerId

public routerId: pulumi.Output<string>;

ID of the router this routing entry belongs to. Changing this creates a new routing entry.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SecGroup

class SecGroup extends CustomResource

constructor

new SecGroup(name: string, args?: SecGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a SecGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecGroupState, opts?: pulumi.CustomResourceOptions): SecGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SecGroup

Returns true if the given object is an instance of SecGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allTags

public allTags: pulumi.Output<string[]>;

The collection of tags assigned on the security group, which have been explicitly and implicitly added.

property deleteDefaultRules

public deleteDefaultRules: pulumi.Output<boolean | undefined>;

Whether or not to delete the default egress security rules. This is false by default. See the below note for more information.

property description

public description: pulumi.Output<string>;

A unique name for the security group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

A unique name for the security group.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new security group.

property tags

public tags: pulumi.Output<string[] | undefined>;

A set of string tags for the security group.

property tenantId

public tenantId: pulumi.Output<string>;

The owner of the security group. Required if admin wants to create a port for another tenant. Changing this creates a new security group.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SecGroupRule

class SecGroupRule extends CustomResource

Manages a V2 neutron security group rule resource within OpenStack. Unlike Nova security groups, neutron separates the group from the rules and also allows an admin to target a specific tenant_id.

Example Usage

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

const secgroup1 = new openstack.networking.SecGroup("secgroup1", {
    description: "My neutron security group",
});
const secgroupRule1 = new openstack.networking.SecGroupRule("secgroupRule1", {
    direction: "ingress",
    ethertype: "IPv4",
    portRangeMax: 22,
    portRangeMin: 22,
    protocol: "tcp",
    remoteIpPrefix: "0.0.0.0/0",
    securityGroupId: secgroup1.id,
});

constructor

new SecGroupRule(name: string, args: SecGroupRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a SecGroupRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecGroupRuleState, opts?: pulumi.CustomResourceOptions): SecGroupRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SecGroupRule

Returns true if the given object is an instance of SecGroupRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

A description of the rule. Changing this creates a new security group rule.

property direction

public direction: pulumi.Output<string>;

The direction of the rule, valid values are ingress or egress. Changing this creates a new security group rule.

property ethertype

public ethertype: pulumi.Output<string>;

The layer 3 protocol type, valid values are IPv4 or IPv6. Changing this creates a new security group rule.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property portRangeMax

public portRangeMax: pulumi.Output<number>;

The higher part of the allowed port range, valid integer value needs to be between 1 and 65535. Changing this creates a new security group rule.

property portRangeMin

public portRangeMin: pulumi.Output<number>;

The lower part of the allowed port range, valid integer value needs to be between 1 and 65535. Changing this creates a new security group rule.

property protocol

public protocol: pulumi.Output<string>;

The layer 4 protocol type, valid values are following. Changing this creates a new security group rule. This is required if you want to specify a port range. * tcp * udp * icmp * ah * dccp * egp * esp * gre * igmp * ipv6-encap * ipv6-frag * ipv6-icmp * ipv6-nonxt * ipv6-opts * ipv6-route * ospf * pgm * rsvp * sctp * udplite * vrrp

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new security group rule.

property remoteGroupId

public remoteGroupId: pulumi.Output<string>;

The remote group id, the value needs to be an Openstack ID of a security group in the same tenant. Changing this creates a new security group rule.

property remoteIpPrefix

public remoteIpPrefix: pulumi.Output<string>;

The remote CIDR, the value needs to be a valid CIDR (i.e. 192.168.0.0/16). Changing this creates a new security group rule.

property securityGroupId

public securityGroupId: pulumi.Output<string>;

The security group id the rule should belong to, the value needs to be an Openstack ID of a security group in the same tenant. Changing this creates a new security group rule.

property tenantId

public tenantId: pulumi.Output<string>;

The owner of the security group. Required if admin wants to create a port for another tenant. Changing this creates a new security group rule.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Subnet

class Subnet extends CustomResource

Manages a V2 Neutron subnet resource within OpenStack.

Example Usage

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

const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const subnet1 = new openstack.networking.Subnet("subnet1", {
    cidr: "192.168.199.0/24",
    networkId: network1.id,
});

constructor

new Subnet(name: string, args: SubnetArgs, opts?: pulumi.CustomResourceOptions)

Create a Subnet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetState, opts?: pulumi.CustomResourceOptions): Subnet

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Subnet

Returns true if the given object is an instance of Subnet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allTags

public allTags: pulumi.Output<string[]>;

The collection of ags assigned on the subnet, which have been explicitly and implicitly added.

property allocationPools

public allocationPools: pulumi.Output<SubnetAllocationPool[]>;

A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. Multiple allocationPool blocks can be declared, providing the subnet with more than one range of IP addresses to use with DHCP. However, each IP range must be from the same CIDR that the subnet is part of. The allocationPool block is documented below.

property allocationPoolsCollection

public allocationPoolsCollection: pulumi.Output<SubnetAllocationPoolsCollection[]>;

A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. The allocationPools block is documented below.

property cidr

public cidr: pulumi.Output<string>;

CIDR representing IP range for this subnet, based on IP version. You can omit this option if you are creating a subnet from a subnet pool.

property description

public description: pulumi.Output<string | undefined>;

Human-readable description of the subnet. Changing this updates the name of the existing subnet.

property dnsNameservers

public dnsNameservers: pulumi.Output<string[] | undefined>;

An array of DNS name server names used by hosts in this subnet. Changing this updates the DNS name servers for the existing subnet.

property enableDhcp

public enableDhcp: pulumi.Output<boolean | undefined>;

The administrative state of the network. Acceptable values are “true” and “false”. Changing this value enables or disables the DHCP capabilities of the existing subnet. Defaults to true.

property gatewayIp

public gatewayIp: pulumi.Output<string>;

Default gateway used by devices in this subnet. Leaving this blank and not setting noGateway will cause a default gateway of .1 to be used. Changing this updates the gateway IP of the existing subnet.

property hostRoutes

public hostRoutes: pulumi.Output<SubnetHostRoute[] | undefined>;

(Deprecated - use openstack.networking.SubnetRoute instead) An array of routes that should be used by devices with IPs from this subnet (not including local subnet route). The hostRoute object structure is documented below. Changing this updates the host routes for the existing subnet.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipVersion

public ipVersion: pulumi.Output<number | undefined>;

IP version, either 4 (default) or 6. Changing this creates a new subnet.

property ipv6AddressMode

public ipv6AddressMode: pulumi.Output<string>;

The IPv6 address mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.

property ipv6RaMode

public ipv6RaMode: pulumi.Output<string>;

The IPv6 Router Advertisement mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.

property name

public name: pulumi.Output<string>;

The name of the subnet. Changing this updates the name of the existing subnet.

property networkId

public networkId: pulumi.Output<string>;

The UUID of the parent network. Changing this creates a new subnet.

property noGateway

public noGateway: pulumi.Output<boolean | undefined>;

Do not set a gateway IP on this subnet. Changing this removes or adds a default gateway IP of the existing subnet.

property prefixLength

public prefixLength: pulumi.Output<number | undefined>;

The prefix length to use when creating a subnet from a subnet pool. The default subnet pool prefix length that was defined when creating the subnet pool will be used if not provided. Changing this creates a new subnet.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnet. If omitted, the region argument of the provider is used. Changing this creates a new subnet.

property subnetpoolId

public subnetpoolId: pulumi.Output<string | undefined>;

The ID of the subnetpool associated with the subnet.

property tags

public tags: pulumi.Output<string[] | undefined>;

A set of string tags for the subnet.

property tenantId

public tenantId: pulumi.Output<string>;

The owner of the subnet. Required if admin wants to create a subnet for another tenant. Changing this creates a new subnet.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueSpecs

public valueSpecs: pulumi.Output<{[key: string]: any} | undefined>;

Map of additional options.

Resource SubnetPool

class SubnetPool extends CustomResource

Manages a V2 Neutron subnetpool resource within OpenStack.

Example Usage

Create a Subnet Pool
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const subnetpool1 = new openstack.networking.SubnetPool("subnetpool1", {
    ipVersion: 6,
    prefixes: [
        "fdf7:b13d:dead:beef::/64",
        "fd65:86cc:a334:39b7::/64",
    ],
});
Create a Subnet from a Subnet Pool
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const subnetpool1 = new openstack.networking.SubnetPool("subnetpool1", {
    prefixes: ["10.11.12.0/24"],
});
const subnet1 = new openstack.networking.Subnet("subnet1", {
    cidr: "10.11.12.0/25",
    networkId: network1.id,
    subnetpoolId: subnetpool1.id,
});

constructor

new SubnetPool(name: string, args: SubnetPoolArgs, opts?: pulumi.CustomResourceOptions)

Create a SubnetPool resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetPoolState, opts?: pulumi.CustomResourceOptions): SubnetPool

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SubnetPool

Returns true if the given object is an instance of SubnetPool. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressScopeId

public addressScopeId: pulumi.Output<string | undefined>;

The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.

property allTags

public allTags: pulumi.Output<string[]>;

The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.

property createdAt

public createdAt: pulumi.Output<string>;

The time at which subnetpool was created.

property defaultPrefixlen

public defaultPrefixlen: pulumi.Output<number>;

The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.

property defaultQuota

public defaultQuota: pulumi.Output<number | undefined>;

The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.

property description

public description: pulumi.Output<string | undefined>;

The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipVersion

public ipVersion: pulumi.Output<number>;

The IP protocol version.

property isDefault

public isDefault: pulumi.Output<boolean | undefined>;

Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.

property maxPrefixlen

public maxPrefixlen: pulumi.Output<number>;

The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.

property minPrefixlen

public minPrefixlen: pulumi.Output<number>;

The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.

property name

public name: pulumi.Output<string>;

The name of the subnetpool. Changing this updates the name of the existing subnetpool.

property prefixes

public prefixes: pulumi.Output<string[]>;

A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.

property projectId

public projectId: pulumi.Output<string>;

The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.

property revisionNumber

public revisionNumber: pulumi.Output<number>;

The revision number of the subnetpool.

property shared

public shared: pulumi.Output<boolean | undefined>;

Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.

property tags

public tags: pulumi.Output<string[] | undefined>;

A set of string tags for the subnetpool.

property updatedAt

public updatedAt: pulumi.Output<string>;

The time at which subnetpool was created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueSpecs

public valueSpecs: pulumi.Output<{[key: string]: any} | undefined>;

Map of additional options.

Resource SubnetRoute

class SubnetRoute extends CustomResource

Creates a routing entry on a OpenStack V2 subnet.

Example Usage

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

const router1 = new openstack.networking.Router("router1", {
    adminStateUp: true,
});
const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const subnet1 = new openstack.networking.Subnet("subnet1", {
    cidr: "192.168.199.0/24",
    ipVersion: 4,
    networkId: network1.id,
});
const subnetRoute1 = new openstack.networking.SubnetRoute("subnetRoute1", {
    destinationCidr: "10.0.1.0/24",
    nextHop: "192.168.199.254",
    subnetId: subnet1.id,
});

constructor

new SubnetRoute(name: string, args: SubnetRouteArgs, opts?: pulumi.CustomResourceOptions)

Create a SubnetRoute resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetRouteState, opts?: pulumi.CustomResourceOptions): SubnetRoute

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SubnetRoute

Returns true if the given object is an instance of SubnetRoute. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property destinationCidr

public destinationCidr: pulumi.Output<string>;

CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property nextHop

public nextHop: pulumi.Output<string>;

IP address of the next hop gateway. Changing this creates a new routing entry.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

property subnetId

public subnetId: pulumi.Output<string>;

ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Trunk

class Trunk extends CustomResource

Manages a networking V2 trunk resource within OpenStack.

Example Usage

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

const network1 = new openstack.networking.Network("network1", {
    adminStateUp: true,
});
const subnet1 = new openstack.networking.Subnet("subnet1", {
    cidr: "192.168.1.0/24",
    enableDhcp: true,
    ipVersion: 4,
    networkId: network1.id,
    noGateway: true,
});
const parentPort1 = new openstack.networking.Port("parentPort1", {
    adminStateUp: true,
    networkId: network1.id,
}, { dependsOn: [subnet1] });
const subport1 = new openstack.networking.Port("subport1", {
    adminStateUp: true,
    networkId: network1.id,
}, { dependsOn: [subnet1] });
const trunk1 = new openstack.networking.Trunk("trunk1", {
    adminStateUp: true,
    portId: parentPort1.id,
    subPorts: [{
        portId: subport1.id,
        segmentationId: 1,
        segmentationType: "vlan",
    }],
});
const instance1 = new openstack.compute.Instance("instance1", {
    networks: [{
        port: trunk1.portId,
    }],
    securityGroups: ["default"],
});

constructor

new Trunk(name: string, args: TrunkArgs, opts?: pulumi.CustomResourceOptions)

Create a Trunk resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TrunkState, opts?: pulumi.CustomResourceOptions): Trunk

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Trunk

Returns true if the given object is an instance of Trunk. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property adminStateUp

public adminStateUp: pulumi.Output<boolean | undefined>;

Administrative up/down status for the trunk (must be “true” or “false” if provided). Changing this updates the adminStateUp of an existing trunk.

property allTags

public allTags: pulumi.Output<string[]>;

The collection of tags assigned on the trunk, which have been explicitly and implicitly added.

property description

public description: pulumi.Output<string | undefined>;

Human-readable description of the trunk. Changing this updates the name of the existing trunk.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

A unique name for the trunk. Changing this updates the name of an existing trunk.

property portId

public portId: pulumi.Output<string>;

The ID of the port to be made a subport of the trunk.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a trunk. If omitted, the region argument of the provider is used. Changing this creates a new trunk.

property subPorts

public subPorts: pulumi.Output<TrunkSubPort[] | undefined>;

The set of ports that will be made subports of the trunk. The structure of each subport is described below.

property tags

public tags: pulumi.Output<string[] | undefined>;

A set of string tags for the port.

property tenantId

public tenantId: pulumi.Output<string>;

The owner of the Trunk. Required if admin wants to create a trunk on behalf of another tenant. Changing this creates a new trunk.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getAddressScope

getAddressScope(args?: GetAddressScopeArgs, opts?: pulumi.InvokeOptions): Promise<GetAddressScopeResult>

Use this data source to get the ID of an available OpenStack address-scope.

Example Usage

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

const publicAddressscope = pulumi.output(openstack.networking.getAddressScope({
    ipVersion: 4,
    name: "publicAddressscope",
    shared: true,
}, { async: true }));

Function getFloatingIp

getFloatingIp(args?: GetFloatingIpArgs, opts?: pulumi.InvokeOptions): Promise<GetFloatingIpResult>

Use this data source to get the ID of an available OpenStack floating IP.

Example Usage

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

const floatingip1 = pulumi.output(openstack.networking.getFloatingIp({
    address: "192.168.0.4",
}, { async: true }));

Function getNetwork

getNetwork(args?: GetNetworkArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkResult>

Use this data source to get the ID of an available OpenStack network.

Example Usage

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

const network = pulumi.output(openstack.networking.getNetwork({
    name: "tfTestNetwork",
}, { async: true }));

Function getPort

getPort(args?: GetPortArgs, opts?: pulumi.InvokeOptions): Promise<GetPortResult>

Use this data source to get the ID of an available OpenStack port.

Example Usage

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

const port1 = pulumi.output(openstack.networking.getPort({
    name: "port1",
}, { async: true }));

Function getPortIds

getPortIds(args?: GetPortIdsArgs, opts?: pulumi.InvokeOptions): Promise<GetPortIdsResult>

Use this data source to get a list of Openstack Port IDs matching the specified criteria.

Example Usage

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

const ports = pulumi.output(openstack.networking.getPortIds({
    name: "port",
}, { async: true }));

Function getQosBandwidthLimitRule

getQosBandwidthLimitRule(args: GetQosBandwidthLimitRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetQosBandwidthLimitRuleResult>

Use this data source to get the ID of an available OpenStack QoS bandwidth limit rule.

Example Usage

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

const qosBandwidthLimitRule1 = pulumi.output(openstack.networking.getQosBandwidthLimitRule({
    maxKbps: 300,
}, { async: true }));

Function getQosDscpMarkingRule

getQosDscpMarkingRule(args: GetQosDscpMarkingRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetQosDscpMarkingRuleResult>

Use this data source to get the ID of an available OpenStack QoS DSCP marking rule.

Example Usage

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

const qosDscpMarkingRule1 = pulumi.output(openstack.networking.getQosDscpMarkingRule({
    dscpMark: 26,
}, { async: true }));

Function getQosMinimumBandwidthRule

getQosMinimumBandwidthRule(args: GetQosMinimumBandwidthRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetQosMinimumBandwidthRuleResult>

Use this data source to get the ID of an available OpenStack QoS minimum bandwidth rule.

Example Usage

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

const qosMinBwRule1 = pulumi.output(openstack.networking.getQosMinimumBandwidthRule({
    minKbps: 2000,
}, { async: true }));

Function getQosPolicy

getQosPolicy(args?: GetQosPolicyArgs, opts?: pulumi.InvokeOptions): Promise<GetQosPolicyResult>

Use this data source to get the ID of an available OpenStack QoS policy.

Example Usage

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

const qosPolicy1 = pulumi.output(openstack.networking.getQosPolicy({
    name: "qosPolicy1",
}, { async: true }));

Function getRouter

getRouter(args?: GetRouterArgs, opts?: pulumi.InvokeOptions): Promise<GetRouterResult>

Use this data source to get the ID of an available OpenStack router.

Example Usage

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

const router = pulumi.output(openstack.networking.getRouter({
    name: "router1",
}, { async: true }));

Function getSecGroup

getSecGroup(args?: GetSecGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetSecGroupResult>

Use this data source to get the ID of an available OpenStack security group.

Example Usage

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

const secgroup = pulumi.output(openstack.networking.getSecGroup({
    name: "tfTestSecgroup",
}, { async: true }));

Function getSubnet

getSubnet(args?: GetSubnetArgs, opts?: pulumi.InvokeOptions): Promise<GetSubnetResult>

Use this data source to get the ID of an available OpenStack subnet.

Example Usage

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

const subnet1 = pulumi.output(openstack.networking.getSubnet({
    name: "subnet1",
}, { async: true }));

Function getSubnetPool

getSubnetPool(args?: GetSubnetPoolArgs, opts?: pulumi.InvokeOptions): Promise<GetSubnetPoolResult>

Use this data source to get the ID of an available OpenStack subnetpool.

Example Usage

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

const subnetpool1 = pulumi.output(openstack.networking.getSubnetPool({
    name: "subnetpool1",
}, { async: true }));

Function getTrunk

getTrunk(args?: GetTrunkArgs, opts?: pulumi.InvokeOptions): Promise<GetTrunkResult>

Use this data source to get the ID of an available OpenStack trunk.

Example Usage

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

const trunk1 = pulumi.output(openstack.networking.getTrunk({
    name: "trunk1",
}, { async: true }));

Others

interface AddressScopeArgs

interface AddressScopeArgs

The set of arguments for constructing a AddressScope resource.

property ipVersion

ipVersion?: pulumi.Input<number>;

IP version, either 4 (default) or 6. Changing this creates a new address-scope.

property name

name?: pulumi.Input<string>;

The name of the address-scope. Changing this updates the name of the existing address-scope.

property projectId

projectId?: pulumi.Input<string>;

The owner of the address-scope. Required if admin wants to create a address-scope for another project. Changing this creates a new address-scope.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron address-scope. If omitted, the region argument of the provider is used. Changing this creates a new address-scope.

property shared

shared?: pulumi.Input<boolean>;

Indicates whether this address-scope is shared across all projects. Changing this updates the shared status of the existing address-scope.

interface AddressScopeState

interface AddressScopeState

Input properties used for looking up and filtering AddressScope resources.

property ipVersion

ipVersion?: pulumi.Input<number>;

IP version, either 4 (default) or 6. Changing this creates a new address-scope.

property name

name?: pulumi.Input<string>;

The name of the address-scope. Changing this updates the name of the existing address-scope.

property projectId

projectId?: pulumi.Input<string>;

The owner of the address-scope. Required if admin wants to create a address-scope for another project. Changing this creates a new address-scope.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron address-scope. If omitted, the region argument of the provider is used. Changing this creates a new address-scope.

property shared

shared?: pulumi.Input<boolean>;

Indicates whether this address-scope is shared across all projects. Changing this updates the shared status of the existing address-scope.

interface FloatingIpArgs

interface FloatingIpArgs

The set of arguments for constructing a FloatingIp resource.

property address

address?: pulumi.Input<string>;

The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.

property description

description?: pulumi.Input<string>;

Human-readable description for the floating IP.

property dnsDomain

dnsDomain?: pulumi.Input<string>;

The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.

property dnsName

dnsName?: pulumi.Input<string>;

The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.

property fixedIp

fixedIp?: pulumi.Input<string>;

Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.

property pool

pool: pulumi.Input<string>;

The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.

property portId

portId?: pulumi.Input<string>;

ID of an existing port with at least one IP address to associate with this floating IP.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).

property subnetId

subnetId?: pulumi.Input<string>;

The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the floating IP.

property tenantId

tenantId?: pulumi.Input<string>;

The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface FloatingIpAssociateArgs

interface FloatingIpAssociateArgs

The set of arguments for constructing a FloatingIpAssociate resource.

property fixedIp

fixedIp?: pulumi.Input<string>;

property floatingIp

floatingIp: pulumi.Input<string>;

IP Address of an existing floating IP.

property portId

portId: pulumi.Input<string>;

ID of an existing port with at least one IP address to associate with this floating IP.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).

interface FloatingIpAssociateState

interface FloatingIpAssociateState

Input properties used for looking up and filtering FloatingIpAssociate resources.

property fixedIp

fixedIp?: pulumi.Input<string>;

property floatingIp

floatingIp?: pulumi.Input<string>;

IP Address of an existing floating IP.

property portId

portId?: pulumi.Input<string>;

ID of an existing port with at least one IP address to associate with this floating IP.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).

interface FloatingIpState

interface FloatingIpState

Input properties used for looking up and filtering FloatingIp resources.

property address

address?: pulumi.Input<string>;

The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.

property allTags

allTags?: pulumi.Input<pulumi.Input<string>[]>;

The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.

property description

description?: pulumi.Input<string>;

Human-readable description for the floating IP.

property dnsDomain

dnsDomain?: pulumi.Input<string>;

The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.

property dnsName

dnsName?: pulumi.Input<string>;

The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.

property fixedIp

fixedIp?: pulumi.Input<string>;

Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.

property pool

pool?: pulumi.Input<string>;

The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.

property portId

portId?: pulumi.Input<string>;

ID of an existing port with at least one IP address to associate with this floating IP.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).

property subnetId

subnetId?: pulumi.Input<string>;

The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the floating IP.

property tenantId

tenantId?: pulumi.Input<string>;

The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface GetAddressScopeArgs

interface GetAddressScopeArgs

A collection of arguments for invoking getAddressScope.

property ipVersion

ipVersion?: undefined | number;

IP version.

property name

name?: undefined | string;

Name of the address-scope.

property projectId

projectId?: undefined | string;

The owner of the address-scope.

property region

region?: undefined | string;

The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve address-scopes. If omitted, the region argument of the provider is used.

property shared

shared?: undefined | false | true;

Indicates whether this address-scope is shared across all projects.

interface GetAddressScopeResult

interface GetAddressScopeResult

A collection of values returned by getAddressScope.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ipVersion

ipVersion?: undefined | number;

See Argument Reference above.

property name

name?: undefined | string;

See Argument Reference above.

property projectId

projectId?: undefined | string;

See Argument Reference above.

property region

region?: undefined | string;

property shared

shared?: undefined | false | true;

See Argument Reference above.

interface GetFloatingIpArgs

interface GetFloatingIpArgs

A collection of arguments for invoking getFloatingIp.

property address

address?: undefined | string;

The IP address of the floating IP.

property description

description?: undefined | string;

Human-readable description of the floating IP.

property fixedIp

fixedIp?: undefined | string;

The specific IP address of the internal port which should be associated with the floating IP.

property pool

pool?: undefined | string;

The name of the pool from which the floating IP belongs to.

property portId

portId?: undefined | string;

The ID of the port the floating IP is attached.

property region

region?: undefined | string;

The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve floating IP ids. If omitted, the region argument of the provider is used.

property status

status?: undefined | string;

status of the floating IP (ACTIVE/DOWN).

property tags

tags?: string[];

The list of floating IP tags to filter.

property tenantId

tenantId?: undefined | string;

The owner of the floating IP.

interface GetFloatingIpResult

interface GetFloatingIpResult

A collection of values returned by getFloatingIp.

property address

address?: undefined | string;

property allTags

allTags: string[];

A set of string tags applied on the floating IP.

property description

description?: undefined | string;

property dnsDomain

dnsDomain: string;

The floating IP DNS domain. Available, when Neutron DNS extension is enabled.

property dnsName

dnsName: string;

The floating IP DNS name. Available, when Neutron DNS extension is enabled.

property fixedIp

fixedIp?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property pool

pool?: undefined | string;

property portId

portId?: undefined | string;

property region

region?: undefined | string;

property status

status?: undefined | string;

property tags

tags?: string[];

property tenantId

tenantId?: undefined | string;

interface GetNetworkArgs

interface GetNetworkArgs

A collection of arguments for invoking getNetwork.

property description

description?: undefined | string;

Human-readable description of the network.

property external

external?: undefined | false | true;

The external routing facility of the network.

property matchingSubnetCidr

matchingSubnetCidr?: undefined | string;

The CIDR of a subnet within the network.

property mtu

mtu?: undefined | number;

The network MTU to filter. Available, when Neutron net-mtu extension is enabled.

property name

name?: undefined | string;

The name of the network.

property networkId

networkId?: undefined | string;

The ID of the network.

property region

region?: undefined | string;

The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve networks ids. If omitted, the region argument of the provider is used.

property status

status?: undefined | string;

The status of the network.

property tags

tags?: string[];

The list of network tags to filter.

property tenantId

tenantId?: undefined | string;

The owner of the network.

property transparentVlan

transparentVlan?: undefined | false | true;

The VLAN transparent attribute for the network.

interface GetNetworkResult

interface GetNetworkResult

A collection of values returned by getNetwork.

property adminStateUp

adminStateUp: string;

The administrative state of the network.

property allTags

allTags: string[];

The set of string tags applied on the network.

property availabilityZoneHints

availabilityZoneHints: string[];

The availability zone candidates for the network.

property description

description?: undefined | string;

See Argument Reference above.

property dnsDomain

dnsDomain: string;

The network DNS domain. Available, when Neutron DNS extension is enabled

property external

external?: undefined | false | true;

See Argument Reference above.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property matchingSubnetCidr

matchingSubnetCidr?: undefined | string;

property mtu

mtu?: undefined | number;

See Argument Reference above.

property name

name?: undefined | string;

See Argument Reference above.

property networkId

networkId?: undefined | string;

property region

region: string;

See Argument Reference above.

property shared

shared: string;

Specifies whether the network resource can be accessed by any tenant or not.

property status

status?: undefined | string;

property tags

tags?: string[];

property tenantId

tenantId?: undefined | string;

property transparentVlan

transparentVlan?: undefined | false | true;

See Argument Reference above.

interface GetPortArgs

interface GetPortArgs

A collection of arguments for invoking getPort.

property adminStateUp

adminStateUp?: undefined | false | true;

The administrative state of the port.

property description

description?: undefined | string;

Human-readable description of the port.

property deviceId

deviceId?: undefined | string;

The ID of the device the port belongs to.

property deviceOwner

deviceOwner?: undefined | string;

The device owner of the port.

property dnsName

dnsName?: undefined | string;

The port DNS name to filter. Available, when Neutron DNS extension is enabled.

property fixedIp

fixedIp?: undefined | string;

The port IP address filter.

property macAddress

macAddress?: undefined | string;

The MAC address of the port.

property name

name?: undefined | string;

The name of the port.

property networkId

networkId?: undefined | string;

The ID of the network the port belongs to.

property portId

portId?: undefined | string;

The ID of the port.

property projectId

projectId?: undefined | string;

The owner of the port.

property region

region?: undefined | string;

The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve port ids. If omitted, the region argument of the provider is used.

property securityGroupIds

securityGroupIds?: string[];

The list of port security group IDs to filter.

property status

status?: undefined | string;

The status of the port.

property tags

tags?: string[];

The list of port tags to filter.

property tenantId

tenantId?: undefined | string;

interface GetPortIdsArgs

interface GetPortIdsArgs

A collection of arguments for invoking getPortIds.

property adminStateUp

adminStateUp?: undefined | false | true;

The administrative state of the port.

property description

description?: undefined | string;

Human-readable description of the port.

property deviceId

deviceId?: undefined | string;

The ID of the device the port belongs to.

property deviceOwner

deviceOwner?: undefined | string;

The device owner of the port.

property dnsName

dnsName?: undefined | string;

property fixedIp

fixedIp?: undefined | string;

The port IP address filter.

property macAddress

macAddress?: undefined | string;

The MAC address of the port.

property name

name?: undefined | string;

The name of the port.

property networkId

networkId?: undefined | string;

The ID of the network the port belongs to.

property projectId

projectId?: undefined | string;

The owner of the port.

property region

region?: undefined | string;

The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve port ids. If omitted, the region argument of the provider is used.

property securityGroupIds

securityGroupIds?: string[];

The list of port security group IDs to filter.

property sortDirection

sortDirection?: undefined | string;

Order the results in either asc or desc. Defaults to none.

property sortKey

sortKey?: undefined | string;

Sort ports based on a certain key. Defaults to none.

property status

status?: undefined | string;

The status of the port.

property tags

tags?: string[];

The list of port tags to filter.

property tenantId

tenantId?: undefined | string;

interface GetPortIdsResult

interface GetPortIdsResult

A collection of values returned by getPortIds.

property adminStateUp

adminStateUp?: undefined | false | true;

property description

description?: undefined | string;

property deviceId

deviceId?: undefined | string;

property deviceOwner

deviceOwner?: undefined | string;

property dnsName

dnsName?: undefined | string;

property fixedIp

fixedIp?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

property macAddress

macAddress?: undefined | string;

property name

name?: undefined | string;

property networkId

networkId?: undefined | string;

property projectId

projectId?: undefined | string;

property region

region?: undefined | string;

property securityGroupIds

securityGroupIds?: string[];

property sortDirection

sortDirection?: undefined | string;

property sortKey

sortKey?: undefined | string;

property status

status?: undefined | string;

property tags

tags?: string[];

property tenantId

tenantId?: undefined | string;

interface GetPortResult

interface GetPortResult

A collection of values returned by getPort.

property adminStateUp

adminStateUp?: undefined | false | true;

See Argument Reference above.

property allFixedIps

allFixedIps: string[];

The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.

property allSecurityGroupIds

allSecurityGroupIds: string[];

The set of security group IDs applied on the port.

property allTags

allTags: string[];

The set of string tags applied on the port.

property allowedAddressPairs

allowedAddressPairs: GetPortAllowedAddressPair[];

An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.

property bindings

bindings: GetPortBinding[];

The port binding information. The structure is described below.

property description

description?: undefined | string;

See Argument Reference above.

property deviceId

deviceId?: undefined | string;

See Argument Reference above.

property deviceOwner

deviceOwner?: undefined | string;

See Argument Reference above.

property dnsAssignments

dnsAssignments: {[key: string]: any}[];

The list of maps representing port DNS assignments.

property dnsName

dnsName?: undefined | string;

See Argument Reference above.

property extraDhcpOptions

extraDhcpOptions: GetPortExtraDhcpOption[];

An extra DHCP option configured on the port. The structure is described below.

property fixedIp

fixedIp?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property macAddress

macAddress?: undefined | string;

The additional MAC address.

property name

name?: undefined | string;

Name of the DHCP option.

property networkId

networkId?: undefined | string;

See Argument Reference above.

property portId

portId?: undefined | string;

See Argument Reference above.

property projectId

projectId?: undefined | string;

See Argument Reference above.

property region

region?: undefined | string;

See Argument Reference above.

property securityGroupIds

securityGroupIds?: string[];

property status

status?: undefined | string;

property tags

tags?: string[];

property tenantId

tenantId?: undefined | string;

interface GetQosBandwidthLimitRuleArgs

interface GetQosBandwidthLimitRuleArgs

A collection of arguments for invoking getQosBandwidthLimitRule.

property maxBurstKbps

maxBurstKbps?: undefined | number;

The maximum burst size in kilobits of a QoS bandwidth limit rule.

property maxKbps

maxKbps?: undefined | number;

The maximum kilobits per second of a QoS bandwidth limit rule.

property qosPolicyId

qosPolicyId: string;

The QoS policy reference.

property region

region?: undefined | string;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used.

interface GetQosBandwidthLimitRuleResult

interface GetQosBandwidthLimitRuleResult

A collection of values returned by getQosBandwidthLimitRule.

property direction

direction: string;

See Argument Reference above.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property maxBurstKbps

maxBurstKbps: number;

See Argument Reference above.

property maxKbps

maxKbps: number;

See Argument Reference above.

property qosPolicyId

qosPolicyId: string;

See Argument Reference above.

property region

region: string;

See Argument Reference above.

interface GetQosDscpMarkingRuleArgs

interface GetQosDscpMarkingRuleArgs

A collection of arguments for invoking getQosDscpMarkingRule.

property dscpMark

dscpMark?: undefined | number;

The value of a DSCP mark.

property qosPolicyId

qosPolicyId: string;

The QoS policy reference.

property region

region?: undefined | string;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS DSCP marking rule. If omitted, the region argument of the provider is used.

interface GetQosDscpMarkingRuleResult

interface GetQosDscpMarkingRuleResult

A collection of values returned by getQosDscpMarkingRule.

property dscpMark

dscpMark: number;

See Argument Reference above.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property qosPolicyId

qosPolicyId: string;

See Argument Reference above.

property region

region: string;

See Argument Reference above.

interface GetQosMinimumBandwidthRuleArgs

interface GetQosMinimumBandwidthRuleArgs

A collection of arguments for invoking getQosMinimumBandwidthRule.

property direction

direction?: undefined | string;

property minKbps

minKbps?: undefined | number;

The value of a minimum kbps bandwidth.

property qosPolicyId

qosPolicyId: string;

The QoS policy reference.

property region

region?: undefined | string;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS minimum bandwidth rule. If omitted, the region argument of the provider is used.

interface GetQosMinimumBandwidthRuleResult

interface GetQosMinimumBandwidthRuleResult

A collection of values returned by getQosMinimumBandwidthRule.

property direction

direction: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property minKbps

minKbps: number;

See Argument Reference above.

property qosPolicyId

qosPolicyId: string;

See Argument Reference above.

property region

region: string;

See Argument Reference above.

interface GetQosPolicyArgs

interface GetQosPolicyArgs

A collection of arguments for invoking getQosPolicy.

property description

description?: undefined | string;

The human-readable description for the QoS policy.

property isDefault

isDefault?: undefined | false | true;

Whether the QoS policy is default policy or not.

property name

name?: undefined | string;

The name of the QoS policy.

property projectId

projectId?: undefined | string;

The owner of the QoS policy.

property region

region?: undefined | string;

The region in which to obtain the V2 Networking client. A Networking client is needed to retrieve a QoS policy ID. If omitted, the region argument of the provider is used.

property shared

shared?: undefined | false | true;

Whether this QoS policy is shared across all projects.

property tags

tags?: string[];

The list of QoS policy tags to filter.

interface GetQosPolicyResult

interface GetQosPolicyResult

A collection of values returned by getQosPolicy.

property allTags

allTags: string[];

The set of string tags applied on the QoS policy.

property createdAt

createdAt: string;

The time at which QoS policy was created.

property description

description: string;

See Argument Reference above.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property isDefault

isDefault: boolean;

See Argument Reference above.

property name

name: string;

See Argument Reference above.

property projectId

projectId: string;

property region

region: string;

See Argument Reference above.

property revisionNumber

revisionNumber: number;

The revision number of the QoS policy.

property shared

shared: boolean;

See Argument Reference above.

property tags

tags?: string[];

property updatedAt

updatedAt: string;

The time at which QoS policy was created.

interface GetRouterArgs

interface GetRouterArgs

A collection of arguments for invoking getRouter.

property adminStateUp

adminStateUp?: undefined | false | true;

Administrative up/down status for the router (must be “true” or “false” if provided).

property description

description?: undefined | string;

Human-readable description of the router.

property distributed

distributed?: undefined | false | true;

Indicates whether or not to get a distributed router.

property enableSnat

enableSnat?: undefined | false | true;

The value that points out if the Source NAT is enabled on the router.

property name

name?: undefined | string;

The name of the router.

property region

region?: undefined | string;

The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve router ids. If omitted, the region argument of the provider is used.

property routerId

routerId?: undefined | string;

The UUID of the router resource.

property status

status?: undefined | string;

The status of the router (ACTIVE/DOWN).

property tags

tags?: string[];

The list of router tags to filter.

property tenantId

tenantId?: undefined | string;

The owner of the router.

interface GetRouterResult

interface GetRouterResult

A collection of values returned by getRouter.

property adminStateUp

adminStateUp?: undefined | false | true;

property allTags

allTags: string[];

The set of string tags applied on the router.

property availabilityZoneHints

availabilityZoneHints: string[];

The availability zone that is used to make router resources highly available.

property description

description?: undefined | string;

property distributed

distributed?: undefined | false | true;

property enableSnat

enableSnat: boolean;

The value that points out if the Source NAT is enabled on the router.

property externalFixedIps

externalFixedIps: GetRouterExternalFixedIp[];

The external fixed IPs of the router.

property externalNetworkId

externalNetworkId: string;

The network UUID of an external gateway for the router.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name?: undefined | string;

property region

region?: undefined | string;

property routerId

routerId?: undefined | string;

property status

status?: undefined | string;

property tags

tags?: string[];

property tenantId

tenantId?: undefined | string;

interface GetSecGroupArgs

interface GetSecGroupArgs

A collection of arguments for invoking getSecGroup.

property description

description?: undefined | string;

Human-readable description the the subnet.

property name

name?: undefined | string;

The name of the security group.

property region

region?: undefined | string;

The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve security groups ids. If omitted, the region argument of the provider is used.

property secgroupId

secgroupId?: undefined | string;

The ID of the security group.

property tags

tags?: string[];

The list of security group tags to filter.

property tenantId

tenantId?: undefined | string;

The owner of the security group.

interface GetSecGroupResult

interface GetSecGroupResult

A collection of values returned by getSecGroup.

property allTags

allTags: string[];

The set of string tags applied on the security group.

property description

description?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name?: undefined | string;

See Argument Reference above. * description- See Argument Reference above.

property region

region: string;

See Argument Reference above.

property secgroupId

secgroupId?: undefined | string;

property tags

tags?: string[];

property tenantId

tenantId: string;

interface GetSubnetArgs

interface GetSubnetArgs

A collection of arguments for invoking getSubnet.

property cidr

cidr?: undefined | string;

The CIDR of the subnet.

property description

description?: undefined | string;

Human-readable description for the subnet.

property dhcpDisabled

dhcpDisabled?: undefined | false | true;

If the subnet has DHCP disabled.

property dhcpEnabled

dhcpEnabled?: undefined | false | true;

If the subnet has DHCP enabled.

property gatewayIp

gatewayIp?: undefined | string;

The IP of the subnet’s gateway.

property ipVersion

ipVersion?: undefined | number;

The IP version of the subnet (either 4 or 6).

property ipv6AddressMode

ipv6AddressMode?: undefined | string;

The IPv6 address mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.

property ipv6RaMode

ipv6RaMode?: undefined | string;

The IPv6 Router Advertisement mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.

property name

name?: undefined | string;

The name of the subnet.

property networkId

networkId?: undefined | string;

The ID of the network the subnet belongs to.

property region

region?: undefined | string;

The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve subnet ids. If omitted, the region argument of the provider is used.

property subnetId

subnetId?: undefined | string;

The ID of the subnet.

property subnetpoolId

subnetpoolId?: undefined | string;

The ID of the subnetpool associated with the subnet.

property tags

tags?: string[];

The list of subnet tags to filter.

property tenantId

tenantId?: undefined | string;

The owner of the subnet.

interface GetSubnetPoolArgs

interface GetSubnetPoolArgs

A collection of arguments for invoking getSubnetPool.

property addressScopeId

addressScopeId?: undefined | string;

The Neutron address scope that subnetpools is assigned to.

property defaultPrefixlen

defaultPrefixlen?: undefined | number;

The size of the subnetpool default prefix length.

property defaultQuota

defaultQuota?: undefined | number;

The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets.

property description

description?: undefined | string;

The human-readable description for the subnetpool.

property ipVersion

ipVersion?: undefined | number;

The IP protocol version.

property isDefault

isDefault?: undefined | false | true;

Whether the subnetpool is default subnetpool or not.

property maxPrefixlen

maxPrefixlen?: undefined | number;

The size of the subnetpool max prefix length.

property minPrefixlen

minPrefixlen?: undefined | number;

The size of the subnetpool min prefix length.

property name

name?: undefined | string;

The name of the subnetpool.

property projectId

projectId?: undefined | string;

The owner of the subnetpool.

property region

region?: undefined | string;

The region in which to obtain the V2 Networking client. A Networking client is needed to retrieve a subnetpool id. If omitted, the region argument of the provider is used.

property shared

shared?: undefined | false | true;

Whether this subnetpool is shared across all projects.

property tags

tags?: string[];

The list of subnetpool tags to filter.

interface GetSubnetPoolResult

interface GetSubnetPoolResult

A collection of values returned by getSubnetPool.

property addressScopeId

addressScopeId: string;

See Argument Reference above. * ipVersion -The IP protocol version.

property allTags

allTags: string[];

The set of string tags applied on the subnetpool.

property createdAt

createdAt: string;

The time at which subnetpool was created.

property defaultPrefixlen

defaultPrefixlen: number;

See Argument Reference above.

property defaultQuota

defaultQuota: number;

See Argument Reference above.

property description

description: string;

See Argument Reference above.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ipVersion

ipVersion: number;

property isDefault

isDefault: boolean;

See Argument Reference above.

property maxPrefixlen

maxPrefixlen: number;

See Argument Reference above.

property minPrefixlen

minPrefixlen: number;

See Argument Reference above.

property name

name: string;

See Argument Reference above.

property prefixes

prefixes: string[];

See Argument Reference above.

property projectId

projectId: string;

See Argument Reference above.

property region

region: string;

See Argument Reference above.

property revisionNumber

revisionNumber: number;

The revision number of the subnetpool.

property shared

shared: boolean;

See Argument Reference above.

property tags

tags?: string[];

property updatedAt

updatedAt: string;

The time at which subnetpool was created.

interface GetSubnetResult

interface GetSubnetResult

A collection of values returned by getSubnet.

property allTags

allTags: string[];

A set of string tags applied on the subnet.

property allocationPools

allocationPools: GetSubnetAllocationPool[];

Allocation pools of the subnet.

property cidr

cidr: string;

property description

description: string;

property dhcpDisabled

dhcpDisabled?: undefined | false | true;

property dhcpEnabled

dhcpEnabled?: undefined | false | true;

property dnsNameservers

dnsNameservers: string[];

DNS Nameservers of the subnet.

property enableDhcp

enableDhcp: boolean;

Whether the subnet has DHCP enabled or not.

property gatewayIp

gatewayIp: string;

property hostRoutes

hostRoutes: GetSubnetHostRoute[];

Host Routes of the subnet.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ipVersion

ipVersion: number;

property ipv6AddressMode

ipv6AddressMode: string;

property ipv6RaMode

ipv6RaMode: string;

property name

name: string;

property networkId

networkId: string;

property region

region: string;

See Argument Reference above.

property subnetId

subnetId: string;

property subnetpoolId

subnetpoolId: string;

property tags

tags?: string[];

property tenantId

tenantId: string;

interface GetTrunkArgs

interface GetTrunkArgs

A collection of arguments for invoking getTrunk.

property adminStateUp

adminStateUp?: undefined | false | true;

The administrative state of the trunk.

property description

description?: undefined | string;

Human-readable description of the trunk.

property name

name?: undefined | string;

The name of the trunk.

property portId

portId?: undefined | string;

The ID of the trunk parent port.

property projectId

projectId?: undefined | string;

The owner of the trunk.

property region

region?: undefined | string;

The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve trunk ids. If omitted, the region argument of the provider is used.

property status

status?: undefined | string;

The status of the trunk.

property tags

tags?: string[];

The list of trunk tags to filter.

property trunkId

trunkId?: undefined | string;

The ID of the trunk.

interface GetTrunkResult

interface GetTrunkResult

A collection of values returned by getTrunk.

property adminStateUp

adminStateUp?: undefined | false | true;

property allTags

allTags: string[];

The set of string tags applied on the trunk.

property description

description?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name?: undefined | string;

property portId

portId?: undefined | string;

The ID of the trunk subport.

property projectId

projectId: string;

property region

region: string;

property status

status?: undefined | string;

property subPorts

subPorts: GetTrunkSubPort[];

The set of the trunk subports. The structure of each subport is described below.

property tags

tags?: string[];

property trunkId

trunkId?: undefined | string;

interface NetworkArgs

interface NetworkArgs

The set of arguments for constructing a Network resource.

property adminStateUp

adminStateUp?: pulumi.Input<boolean>;

The administrative state of the network. Acceptable values are “true” and “false”. Changing this value updates the state of the existing network.

property availabilityZoneHints

availabilityZoneHints?: pulumi.Input<pulumi.Input<string>[]>;

An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new network.

property description

description?: pulumi.Input<string>;

Human-readable description of the network. Changing this updates the name of the existing network.

property dnsDomain

dnsDomain?: pulumi.Input<string>;

The network DNS domain. Available, when Neutron DNS extension is enabled. The dnsDomain of a network in conjunction with the dnsName attribute of its ports will be published in an external DNS service when Neutron is configured to integrate with such a service.

property external

external?: pulumi.Input<boolean>;

Specifies whether the network resource has the external routing facility. Valid values are true and false. Defaults to false. Changing this updates the external attribute of the existing network.

property mtu

mtu?: pulumi.Input<number>;

The network MTU. Available for read-only, when Neutron net-mtu extension is enabled. Available for the modification, when Neutron net-mtu-writable extension is enabled.

property name

name?: pulumi.Input<string>;

The name of the network. Changing this updates the name of the existing network.

property portSecurityEnabled

portSecurityEnabled?: pulumi.Input<boolean>;

Whether to explicitly enable or disable port security on the network. Port Security is usually enabled by default, so omitting this argument will usually result in a value of “true”. Setting this explicitly to false will disable port security. Valid values are true and false.

property qosPolicyId

qosPolicyId?: pulumi.Input<string>;

Reference to the associated QoS policy.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron network. If omitted, the region argument of the provider is used. Changing this creates a new network.

property segments

segments?: pulumi.Input<pulumi.Input<NetworkSegment>[]>;

An array of one or more provider segment objects.

property shared

shared?: pulumi.Input<boolean>;

Specifies whether the network resource can be accessed by any tenant or not. Changing this updates the sharing capabilities of the existing network.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the network.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the network. Required if admin wants to create a network for another tenant. Changing this creates a new network.

property transparentVlan

transparentVlan?: pulumi.Input<boolean>;

Specifies whether the network resource has the VLAN transparent attribute set. Valid values are true and false. Defaults to false. Changing this updates the transparentVlan attribute of the existing network.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface NetworkState

interface NetworkState

Input properties used for looking up and filtering Network resources.

property adminStateUp

adminStateUp?: pulumi.Input<boolean>;

The administrative state of the network. Acceptable values are “true” and “false”. Changing this value updates the state of the existing network.

property allTags

allTags?: pulumi.Input<pulumi.Input<string>[]>;

The collection of tags assigned on the network, which have been explicitly and implicitly added.

property availabilityZoneHints

availabilityZoneHints?: pulumi.Input<pulumi.Input<string>[]>;

An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new network.

property description

description?: pulumi.Input<string>;

Human-readable description of the network. Changing this updates the name of the existing network.

property dnsDomain

dnsDomain?: pulumi.Input<string>;

The network DNS domain. Available, when Neutron DNS extension is enabled. The dnsDomain of a network in conjunction with the dnsName attribute of its ports will be published in an external DNS service when Neutron is configured to integrate with such a service.

property external

external?: pulumi.Input<boolean>;

Specifies whether the network resource has the external routing facility. Valid values are true and false. Defaults to false. Changing this updates the external attribute of the existing network.

property mtu

mtu?: pulumi.Input<number>;

The network MTU. Available for read-only, when Neutron net-mtu extension is enabled. Available for the modification, when Neutron net-mtu-writable extension is enabled.

property name

name?: pulumi.Input<string>;

The name of the network. Changing this updates the name of the existing network.

property portSecurityEnabled

portSecurityEnabled?: pulumi.Input<boolean>;

Whether to explicitly enable or disable port security on the network. Port Security is usually enabled by default, so omitting this argument will usually result in a value of “true”. Setting this explicitly to false will disable port security. Valid values are true and false.

property qosPolicyId

qosPolicyId?: pulumi.Input<string>;

Reference to the associated QoS policy.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron network. If omitted, the region argument of the provider is used. Changing this creates a new network.

property segments

segments?: pulumi.Input<pulumi.Input<NetworkSegment>[]>;

An array of one or more provider segment objects.

property shared

shared?: pulumi.Input<boolean>;

Specifies whether the network resource can be accessed by any tenant or not. Changing this updates the sharing capabilities of the existing network.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the network.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the network. Required if admin wants to create a network for another tenant. Changing this creates a new network.

property transparentVlan

transparentVlan?: pulumi.Input<boolean>;

Specifies whether the network resource has the VLAN transparent attribute set. Valid values are true and false. Defaults to false. Changing this updates the transparentVlan attribute of the existing network.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface PortArgs

interface PortArgs

The set of arguments for constructing a Port resource.

property adminStateUp

adminStateUp?: pulumi.Input<boolean>;

Administrative up/down status for the port (must be “true” or “false” if provided). Changing this updates the adminStateUp of an existing port.

property allowedAddressPairs

allowedAddressPairs?: pulumi.Input<pulumi.Input<PortAllowedAddressPair>[]>;

An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.

property binding

binding?: pulumi.Input<PortBinding>;

The port binding allows to specify binding information for the port. The structure is described below.

property description

description?: pulumi.Input<string>;

Human-readable description of the floating IP. Changing this updates the description of an existing port.

property deviceId

deviceId?: pulumi.Input<string>;

The ID of the device attached to the port. Changing this creates a new port.

property deviceOwner

deviceOwner?: pulumi.Input<string>;

The device owner of the Port. Changing this creates a new port.

property dnsName

dnsName?: pulumi.Input<string>;

The port DNS name. Available, when Neutron DNS extension is enabled.

property extraDhcpOptions

extraDhcpOptions?: pulumi.Input<pulumi.Input<PortExtraDhcpOption>[]>;

An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times.

property fixedIps

fixedIps?: pulumi.Input<pulumi.Input<PortFixedIp>[]>;

An array of desired IPs for this port. The structure is described below.

property macAddress

macAddress?: pulumi.Input<string>;

The additional MAC address.

property name

name?: pulumi.Input<string>;

Name of the DHCP option.

property networkId

networkId: pulumi.Input<string>;

The ID of the network to attach the port to. Changing this creates a new port.

property noFixedIp

noFixedIp?: pulumi.Input<boolean>;

Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.

property noSecurityGroups

noSecurityGroups?: pulumi.Input<boolean>;

If set to true, then no security groups are applied to the port. If set to false and no securityGroupIds are specified, then the Port will yield to the default behavior of the Networking service, which is to usually apply the “default” security group.

property portSecurityEnabled

portSecurityEnabled?: pulumi.Input<boolean>;

Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of “true”. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.

property qosPolicyId

qosPolicyId?: pulumi.Input<string>;

Reference to the associated QoS policy.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of security group IDs to apply to the port. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the port.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the Port. Required if admin wants to create a port for another tenant. Changing this creates a new port.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface PortSecGroupAssociateArgs

interface PortSecGroupAssociateArgs

The set of arguments for constructing a PortSecGroupAssociate resource.

property enforce

enforce?: pulumi.Input<boolean>;

Whether to replace or append the list of security groups, specified in the securityGroupIds. Defaults to false.

property portId

portId: pulumi.Input<string>;

An UUID of the port to apply security groups to.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to manage a port. If omitted, the region argument of the provider is used. Changing this creates a new resource.

property securityGroupIds

securityGroupIds: pulumi.Input<pulumi.Input<string>[]>;

A list of security group IDs to apply to the port. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).

interface PortSecGroupAssociateState

interface PortSecGroupAssociateState

Input properties used for looking up and filtering PortSecGroupAssociate resources.

property allSecurityGroupIds

allSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

The collection of Security Group IDs on the port which have been explicitly and implicitly added.

property enforce

enforce?: pulumi.Input<boolean>;

Whether to replace or append the list of security groups, specified in the securityGroupIds. Defaults to false.

property portId

portId?: pulumi.Input<string>;

An UUID of the port to apply security groups to.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to manage a port. If omitted, the region argument of the provider is used. Changing this creates a new resource.

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of security group IDs to apply to the port. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).

interface PortState

interface PortState

Input properties used for looking up and filtering Port resources.

property adminStateUp

adminStateUp?: pulumi.Input<boolean>;

Administrative up/down status for the port (must be “true” or “false” if provided). Changing this updates the adminStateUp of an existing port.

property allFixedIps

allFixedIps?: pulumi.Input<pulumi.Input<string>[]>;

The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.

property allSecurityGroupIds

allSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

The collection of Security Group IDs on the port which have been explicitly and implicitly added.

property allTags

allTags?: pulumi.Input<pulumi.Input<string>[]>;

The collection of tags assigned on the port, which have been explicitly and implicitly added.

property allowedAddressPairs

allowedAddressPairs?: pulumi.Input<pulumi.Input<PortAllowedAddressPair>[]>;

An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.

property binding

binding?: pulumi.Input<PortBinding>;

The port binding allows to specify binding information for the port. The structure is described below.

property description

description?: pulumi.Input<string>;

Human-readable description of the floating IP. Changing this updates the description of an existing port.

property deviceId

deviceId?: pulumi.Input<string>;

The ID of the device attached to the port. Changing this creates a new port.

property deviceOwner

deviceOwner?: pulumi.Input<string>;

The device owner of the Port. Changing this creates a new port.

property dnsAssignments

dnsAssignments?: pulumi.Input<pulumi.Input<{[key: string]: any}>[]>;

The list of maps representing port DNS assignments.

property dnsName

dnsName?: pulumi.Input<string>;

The port DNS name. Available, when Neutron DNS extension is enabled.

property extraDhcpOptions

extraDhcpOptions?: pulumi.Input<pulumi.Input<PortExtraDhcpOption>[]>;

An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times.

property fixedIps

fixedIps?: pulumi.Input<pulumi.Input<PortFixedIp>[]>;

An array of desired IPs for this port. The structure is described below.

property macAddress

macAddress?: pulumi.Input<string>;

The additional MAC address.

property name

name?: pulumi.Input<string>;

Name of the DHCP option.

property networkId

networkId?: pulumi.Input<string>;

The ID of the network to attach the port to. Changing this creates a new port.

property noFixedIp

noFixedIp?: pulumi.Input<boolean>;

Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.

property noSecurityGroups

noSecurityGroups?: pulumi.Input<boolean>;

If set to true, then no security groups are applied to the port. If set to false and no securityGroupIds are specified, then the Port will yield to the default behavior of the Networking service, which is to usually apply the “default” security group.

property portSecurityEnabled

portSecurityEnabled?: pulumi.Input<boolean>;

Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of “true”. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.

property qosPolicyId

qosPolicyId?: pulumi.Input<string>;

Reference to the associated QoS policy.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of security group IDs to apply to the port. The security groups must be specified by ID and not name (as opposed to how they are configured with the Compute Instance).

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the port.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the Port. Required if admin wants to create a port for another tenant. Changing this creates a new port.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface QosBandwidthLimitRuleArgs

interface QosBandwidthLimitRuleArgs

The set of arguments for constructing a QosBandwidthLimitRule resource.

property direction

direction?: pulumi.Input<string>;

The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS bandwidth limit rule.

property maxBurstKbps

maxBurstKbps?: pulumi.Input<number>;

The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.

property maxKbps

maxKbps: pulumi.Input<number>;

The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.

property qosPolicyId

qosPolicyId: pulumi.Input<string>;

The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

interface QosBandwidthLimitRuleState

interface QosBandwidthLimitRuleState

Input properties used for looking up and filtering QosBandwidthLimitRule resources.

property direction

direction?: pulumi.Input<string>;

The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS bandwidth limit rule.

property maxBurstKbps

maxBurstKbps?: pulumi.Input<number>;

The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.

property maxKbps

maxKbps?: pulumi.Input<number>;

The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.

property qosPolicyId

qosPolicyId?: pulumi.Input<string>;

The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

interface QosDscpMarkingRuleArgs

interface QosDscpMarkingRuleArgs

The set of arguments for constructing a QosDscpMarkingRule resource.

property dscpMark

dscpMark: pulumi.Input<number>;

The value of DSCP mark. Changing this updates the DSCP mark value existing QoS DSCP marking rule.

property qosPolicyId

qosPolicyId: pulumi.Input<string>;

The QoS policy reference. Changing this creates a new QoS DSCP marking rule.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS DSCP marking rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS DSCP marking rule.

interface QosDscpMarkingRuleState

interface QosDscpMarkingRuleState

Input properties used for looking up and filtering QosDscpMarkingRule resources.

property dscpMark

dscpMark?: pulumi.Input<number>;

The value of DSCP mark. Changing this updates the DSCP mark value existing QoS DSCP marking rule.

property qosPolicyId

qosPolicyId?: pulumi.Input<string>;

The QoS policy reference. Changing this creates a new QoS DSCP marking rule.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS DSCP marking rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS DSCP marking rule.

interface QosMinimumBandwidthRuleArgs

interface QosMinimumBandwidthRuleArgs

The set of arguments for constructing a QosMinimumBandwidthRule resource.

property direction

direction?: pulumi.Input<string>;

The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS minimum bandwidth rule.

property minKbps

minKbps: pulumi.Input<number>;

The minimum kilobits per second. Changing this updates the min kbps value of the existing QoS minimum bandwidth rule.

property qosPolicyId

qosPolicyId: pulumi.Input<string>;

The QoS policy reference. Changing this creates a new QoS minimum bandwidth rule.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS minimum bandwidth rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS minimum bandwidth rule.

interface QosMinimumBandwidthRuleState

interface QosMinimumBandwidthRuleState

Input properties used for looking up and filtering QosMinimumBandwidthRule resources.

property direction

direction?: pulumi.Input<string>;

The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS minimum bandwidth rule.

property minKbps

minKbps?: pulumi.Input<number>;

The minimum kilobits per second. Changing this updates the min kbps value of the existing QoS minimum bandwidth rule.

property qosPolicyId

qosPolicyId?: pulumi.Input<string>;

The QoS policy reference. Changing this creates a new QoS minimum bandwidth rule.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS minimum bandwidth rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS minimum bandwidth rule.

interface QosPolicyArgs

interface QosPolicyArgs

The set of arguments for constructing a QosPolicy resource.

property description

description?: pulumi.Input<string>;

The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.

property isDefault

isDefault?: pulumi.Input<boolean>;

Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.

property name

name?: pulumi.Input<string>;

The name of the QoS policy. Changing this updates the name of the existing QoS policy.

property projectId

projectId?: pulumi.Input<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.

property region

region?: pulumi.Input<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.

property shared

shared?: pulumi.Input<boolean>;

Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the QoS policy.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface QosPolicyState

interface QosPolicyState

Input properties used for looking up and filtering QosPolicy resources.

property allTags

allTags?: pulumi.Input<pulumi.Input<string>[]>;

The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.

property createdAt

createdAt?: pulumi.Input<string>;

The time at which QoS policy was created.

property description

description?: pulumi.Input<string>;

The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.

property isDefault

isDefault?: pulumi.Input<boolean>;

Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.

property name

name?: pulumi.Input<string>;

The name of the QoS policy. Changing this updates the name of the existing QoS policy.

property projectId

projectId?: pulumi.Input<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.

property region

region?: pulumi.Input<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.

property revisionNumber

revisionNumber?: pulumi.Input<number>;

The revision number of the QoS policy.

property shared

shared?: pulumi.Input<boolean>;

Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the QoS policy.

property updatedAt

updatedAt?: pulumi.Input<string>;

The time at which QoS policy was created.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface QuotaV2Args

interface QuotaV2Args

The set of arguments for constructing a QuotaV2 resource.

property floatingip

floatingip?: pulumi.Input<number>;

Quota value for floating IPs. Changing this updates the existing quota.

property network

network?: pulumi.Input<number>;

Quota value for networks. Changing this updates the existing quota.

property port

port?: pulumi.Input<number>;

Quota value for ports. Changing this updates the existing quota.

property projectId

projectId: pulumi.Input<string>;

ID of the project to manage quota. Changing this creates new quota.

property rbacPolicy

rbacPolicy?: pulumi.Input<number>;

Quota value for RBAC policies. Changing this updates the existing quota.

property region

region?: pulumi.Input<string>;

The region in which to create the quota. If omitted, the region argument of the provider is used. Changing this creates new quota.

property router

router?: pulumi.Input<number>;

Quota value for routers. Changing this updates the existing quota.

property securityGroup

securityGroup?: pulumi.Input<number>;

Quota value for security groups. Changing this updates the existing quota.

property securityGroupRule

securityGroupRule?: pulumi.Input<number>;

Quota value for security group rules. Changing this updates the existing quota.

property subnet

subnet?: pulumi.Input<number>;

Quota value for subnets. Changing this updates the existing quota.

property subnetpool

subnetpool?: pulumi.Input<number>;

Quota value for subnetpools. Changing this updates the existing quota.

interface QuotaV2State

interface QuotaV2State

Input properties used for looking up and filtering QuotaV2 resources.

property floatingip

floatingip?: pulumi.Input<number>;

Quota value for floating IPs. Changing this updates the existing quota.

property network

network?: pulumi.Input<number>;

Quota value for networks. Changing this updates the existing quota.

property port

port?: pulumi.Input<number>;

Quota value for ports. Changing this updates the existing quota.

property projectId

projectId?: pulumi.Input<string>;

ID of the project to manage quota. Changing this creates new quota.

property rbacPolicy

rbacPolicy?: pulumi.Input<number>;

Quota value for RBAC policies. Changing this updates the existing quota.

property region

region?: pulumi.Input<string>;

The region in which to create the quota. If omitted, the region argument of the provider is used. Changing this creates new quota.

property router

router?: pulumi.Input<number>;

Quota value for routers. Changing this updates the existing quota.

property securityGroup

securityGroup?: pulumi.Input<number>;

Quota value for security groups. Changing this updates the existing quota.

property securityGroupRule

securityGroupRule?: pulumi.Input<number>;

Quota value for security group rules. Changing this updates the existing quota.

property subnet

subnet?: pulumi.Input<number>;

Quota value for subnets. Changing this updates the existing quota.

property subnetpool

subnetpool?: pulumi.Input<number>;

Quota value for subnetpools. Changing this updates the existing quota.

interface RbacPolicyV2Args

interface RbacPolicyV2Args

The set of arguments for constructing a RbacPolicyV2 resource.

property action

action: pulumi.Input<string>;

Action for the RBAC policy. Can either be accessAsExternal or accessAsShared.

property objectId

objectId: pulumi.Input<string>;

The ID of the objectType resource. An objectType of network returns a network ID and an objectType of qosPolicy returns a QoS ID.

property objectType

objectType: pulumi.Input<string>;

The type of the object that the RBAC policy affects. Can either be qos-policy or network.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

property targetTenant

targetTenant: pulumi.Input<string>;

The ID of the tenant to which the RBAC policy will be enforced.

interface RbacPolicyV2State

interface RbacPolicyV2State

Input properties used for looking up and filtering RbacPolicyV2 resources.

property action

action?: pulumi.Input<string>;

Action for the RBAC policy. Can either be accessAsExternal or accessAsShared.

property objectId

objectId?: pulumi.Input<string>;

The ID of the objectType resource. An objectType of network returns a network ID and an objectType of qosPolicy returns a QoS ID.

property objectType

objectType?: pulumi.Input<string>;

The type of the object that the RBAC policy affects. Can either be qos-policy or network.

property projectId

projectId?: pulumi.Input<string>;

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

property targetTenant

targetTenant?: pulumi.Input<string>;

The ID of the tenant to which the RBAC policy will be enforced.

interface RouterArgs

interface RouterArgs

The set of arguments for constructing a Router resource.

property adminStateUp

adminStateUp?: pulumi.Input<boolean>;

Administrative up/down status for the router (must be “true” or “false” if provided). Changing this updates the adminStateUp of an existing router.

property availabilityZoneHints

availabilityZoneHints?: pulumi.Input<pulumi.Input<string>[]>;

An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.

property description

description?: pulumi.Input<string>;

Human-readable description for the router.

property distributed

distributed?: pulumi.Input<boolean>;

Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.

property enableSnat

enableSnat?: pulumi.Input<boolean>;

Enable Source NAT for the router. Valid values are “true” or “false”. An externalNetworkId has to be set in order to set this property. Changing this updates the enableSnat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.

property externalFixedIps

externalFixedIps?: pulumi.Input<pulumi.Input<RouterExternalFixedIp>[]>;

An external fixed IP for the router. This can be repeated. The structure is described below. An externalNetworkId has to be set in order to set this property. Changing this updates the external fixed IPs of the router.

property externalGateway

DEPRECATED use external_network_id instead
externalGateway?: pulumi.Input<string>;

The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of an existing router.

property externalNetworkId

externalNetworkId?: pulumi.Input<string>;

The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.

property name

name?: pulumi.Input<string>;

A unique name for the router. Changing this updates the name of an existing router.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the router.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional driver-specific options.

property vendorOptions

vendorOptions?: pulumi.Input<RouterVendorOptions>;

Map of additional vendor-specific options. Supported options are described below.

interface RouterInterfaceArgs

interface RouterInterfaceArgs

The set of arguments for constructing a RouterInterface resource.

property portId

portId?: pulumi.Input<string>;

ID of the port this interface connects to. Changing this creates a new router interface.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.

property routerId

routerId: pulumi.Input<string>;

ID of the router this interface belongs to. Changing this creates a new router interface.

property subnetId

subnetId?: pulumi.Input<string>;

ID of the subnet this interface connects to. Changing this creates a new router interface.

interface RouterInterfaceState

interface RouterInterfaceState

Input properties used for looking up and filtering RouterInterface resources.

property portId

portId?: pulumi.Input<string>;

ID of the port this interface connects to. Changing this creates a new router interface.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router interface.

property routerId

routerId?: pulumi.Input<string>;

ID of the router this interface belongs to. Changing this creates a new router interface.

property subnetId

subnetId?: pulumi.Input<string>;

ID of the subnet this interface connects to. Changing this creates a new router interface.

interface RouterRouteArgs

interface RouterRouteArgs

The set of arguments for constructing a RouterRoute resource.

property destinationCidr

destinationCidr: pulumi.Input<string>;

CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.

property nextHop

nextHop: pulumi.Input<string>;

IP address of the next hop gateway. Changing this creates a new routing entry.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a router. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

property routerId

routerId: pulumi.Input<string>;

ID of the router this routing entry belongs to. Changing this creates a new routing entry.

interface RouterRouteState

interface RouterRouteState

Input properties used for looking up and filtering RouterRoute resources.

property destinationCidr

destinationCidr?: pulumi.Input<string>;

CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.

property nextHop

nextHop?: pulumi.Input<string>;

IP address of the next hop gateway. Changing this creates a new routing entry.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a router. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

property routerId

routerId?: pulumi.Input<string>;

ID of the router this routing entry belongs to. Changing this creates a new routing entry.

interface RouterState

interface RouterState

Input properties used for looking up and filtering Router resources.

property adminStateUp

adminStateUp?: pulumi.Input<boolean>;

Administrative up/down status for the router (must be “true” or “false” if provided). Changing this updates the adminStateUp of an existing router.

property allTags

allTags?: pulumi.Input<pulumi.Input<string>[]>;

The collection of tags assigned on the router, which have been explicitly and implicitly added.

property availabilityZoneHints

availabilityZoneHints?: pulumi.Input<pulumi.Input<string>[]>;

An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.

property description

description?: pulumi.Input<string>;

Human-readable description for the router.

property distributed

distributed?: pulumi.Input<boolean>;

Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.

property enableSnat

enableSnat?: pulumi.Input<boolean>;

Enable Source NAT for the router. Valid values are “true” or “false”. An externalNetworkId has to be set in order to set this property. Changing this updates the enableSnat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.

property externalFixedIps

externalFixedIps?: pulumi.Input<pulumi.Input<RouterExternalFixedIp>[]>;

An external fixed IP for the router. This can be repeated. The structure is described below. An externalNetworkId has to be set in order to set this property. Changing this updates the external fixed IPs of the router.

property externalGateway

DEPRECATED use external_network_id instead
externalGateway?: pulumi.Input<string>;

The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of an existing router.

property externalNetworkId

externalNetworkId?: pulumi.Input<string>;

The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.

property name

name?: pulumi.Input<string>;

A unique name for the router. Changing this updates the name of an existing router.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the router.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional driver-specific options.

property vendorOptions

vendorOptions?: pulumi.Input<RouterVendorOptions>;

Map of additional vendor-specific options. Supported options are described below.

interface SecGroupArgs

interface SecGroupArgs

The set of arguments for constructing a SecGroup resource.

property deleteDefaultRules

deleteDefaultRules?: pulumi.Input<boolean>;

Whether or not to delete the default egress security rules. This is false by default. See the below note for more information.

property description

description?: pulumi.Input<string>;

A unique name for the security group.

property name

name?: pulumi.Input<string>;

A unique name for the security group.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new security group.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the security group.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the security group. Required if admin wants to create a port for another tenant. Changing this creates a new security group.

interface SecGroupRuleArgs

interface SecGroupRuleArgs

The set of arguments for constructing a SecGroupRule resource.

property description

description?: pulumi.Input<string>;

A description of the rule. Changing this creates a new security group rule.

property direction

direction: pulumi.Input<string>;

The direction of the rule, valid values are ingress or egress. Changing this creates a new security group rule.

property ethertype

ethertype: pulumi.Input<string>;

The layer 3 protocol type, valid values are IPv4 or IPv6. Changing this creates a new security group rule.

property portRangeMax

portRangeMax?: pulumi.Input<number>;

The higher part of the allowed port range, valid integer value needs to be between 1 and 65535. Changing this creates a new security group rule.

property portRangeMin

portRangeMin?: pulumi.Input<number>;

The lower part of the allowed port range, valid integer value needs to be between 1 and 65535. Changing this creates a new security group rule.

property protocol

protocol?: pulumi.Input<string>;

The layer 4 protocol type, valid values are following. Changing this creates a new security group rule. This is required if you want to specify a port range. * tcp * udp * icmp * ah * dccp * egp * esp * gre * igmp * ipv6-encap * ipv6-frag * ipv6-icmp * ipv6-nonxt * ipv6-opts * ipv6-route * ospf * pgm * rsvp * sctp * udplite * vrrp

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new security group rule.

property remoteGroupId

remoteGroupId?: pulumi.Input<string>;

The remote group id, the value needs to be an Openstack ID of a security group in the same tenant. Changing this creates a new security group rule.

property remoteIpPrefix

remoteIpPrefix?: pulumi.Input<string>;

The remote CIDR, the value needs to be a valid CIDR (i.e. 192.168.0.0/16). Changing this creates a new security group rule.

property securityGroupId

securityGroupId: pulumi.Input<string>;

The security group id the rule should belong to, the value needs to be an Openstack ID of a security group in the same tenant. Changing this creates a new security group rule.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the security group. Required if admin wants to create a port for another tenant. Changing this creates a new security group rule.

interface SecGroupRuleState

interface SecGroupRuleState

Input properties used for looking up and filtering SecGroupRule resources.

property description

description?: pulumi.Input<string>;

A description of the rule. Changing this creates a new security group rule.

property direction

direction?: pulumi.Input<string>;

The direction of the rule, valid values are ingress or egress. Changing this creates a new security group rule.

property ethertype

ethertype?: pulumi.Input<string>;

The layer 3 protocol type, valid values are IPv4 or IPv6. Changing this creates a new security group rule.

property portRangeMax

portRangeMax?: pulumi.Input<number>;

The higher part of the allowed port range, valid integer value needs to be between 1 and 65535. Changing this creates a new security group rule.

property portRangeMin

portRangeMin?: pulumi.Input<number>;

The lower part of the allowed port range, valid integer value needs to be between 1 and 65535. Changing this creates a new security group rule.

property protocol

protocol?: pulumi.Input<string>;

The layer 4 protocol type, valid values are following. Changing this creates a new security group rule. This is required if you want to specify a port range. * tcp * udp * icmp * ah * dccp * egp * esp * gre * igmp * ipv6-encap * ipv6-frag * ipv6-icmp * ipv6-nonxt * ipv6-opts * ipv6-route * ospf * pgm * rsvp * sctp * udplite * vrrp

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new security group rule.

property remoteGroupId

remoteGroupId?: pulumi.Input<string>;

The remote group id, the value needs to be an Openstack ID of a security group in the same tenant. Changing this creates a new security group rule.

property remoteIpPrefix

remoteIpPrefix?: pulumi.Input<string>;

The remote CIDR, the value needs to be a valid CIDR (i.e. 192.168.0.0/16). Changing this creates a new security group rule.

property securityGroupId

securityGroupId?: pulumi.Input<string>;

The security group id the rule should belong to, the value needs to be an Openstack ID of a security group in the same tenant. Changing this creates a new security group rule.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the security group. Required if admin wants to create a port for another tenant. Changing this creates a new security group rule.

interface SecGroupState

interface SecGroupState

Input properties used for looking up and filtering SecGroup resources.

property allTags

allTags?: pulumi.Input<pulumi.Input<string>[]>;

The collection of tags assigned on the security group, which have been explicitly and implicitly added.

property deleteDefaultRules

deleteDefaultRules?: pulumi.Input<boolean>;

Whether or not to delete the default egress security rules. This is false by default. See the below note for more information.

property description

description?: pulumi.Input<string>;

A unique name for the security group.

property name

name?: pulumi.Input<string>;

A unique name for the security group.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new security group.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the security group.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the security group. Required if admin wants to create a port for another tenant. Changing this creates a new security group.

interface SubnetArgs

interface SubnetArgs

The set of arguments for constructing a Subnet resource.

property allocationPools

allocationPools?: pulumi.Input<pulumi.Input<SubnetAllocationPool>[]>;

A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. Multiple allocationPool blocks can be declared, providing the subnet with more than one range of IP addresses to use with DHCP. However, each IP range must be from the same CIDR that the subnet is part of. The allocationPool block is documented below.

property allocationPoolsCollection

DEPRECATED use allocation_pool instead
allocationPoolsCollection?: pulumi.Input<pulumi.Input<SubnetAllocationPoolsCollection>[]>;

A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. The allocationPools block is documented below.

property cidr

cidr?: pulumi.Input<string>;

CIDR representing IP range for this subnet, based on IP version. You can omit this option if you are creating a subnet from a subnet pool.

property description

description?: pulumi.Input<string>;

Human-readable description of the subnet. Changing this updates the name of the existing subnet.

property dnsNameservers

dnsNameservers?: pulumi.Input<pulumi.Input<string>[]>;

An array of DNS name server names used by hosts in this subnet. Changing this updates the DNS name servers for the existing subnet.

property enableDhcp

enableDhcp?: pulumi.Input<boolean>;

The administrative state of the network. Acceptable values are “true” and “false”. Changing this value enables or disables the DHCP capabilities of the existing subnet. Defaults to true.

property gatewayIp

gatewayIp?: pulumi.Input<string>;

Default gateway used by devices in this subnet. Leaving this blank and not setting noGateway will cause a default gateway of .1 to be used. Changing this updates the gateway IP of the existing subnet.

property hostRoutes

DEPRECATED Use openstack_networking_subnet_route_v2 instead
hostRoutes?: pulumi.Input<pulumi.Input<SubnetHostRoute>[]>;

(Deprecated - use openstack.networking.SubnetRoute instead) An array of routes that should be used by devices with IPs from this subnet (not including local subnet route). The hostRoute object structure is documented below. Changing this updates the host routes for the existing subnet.

property ipVersion

ipVersion?: pulumi.Input<number>;

IP version, either 4 (default) or 6. Changing this creates a new subnet.

property ipv6AddressMode

ipv6AddressMode?: pulumi.Input<string>;

The IPv6 address mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.

property ipv6RaMode

ipv6RaMode?: pulumi.Input<string>;

The IPv6 Router Advertisement mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.

property name

name?: pulumi.Input<string>;

The name of the subnet. Changing this updates the name of the existing subnet.

property networkId

networkId: pulumi.Input<string>;

The UUID of the parent network. Changing this creates a new subnet.

property noGateway

noGateway?: pulumi.Input<boolean>;

Do not set a gateway IP on this subnet. Changing this removes or adds a default gateway IP of the existing subnet.

property prefixLength

prefixLength?: pulumi.Input<number>;

The prefix length to use when creating a subnet from a subnet pool. The default subnet pool prefix length that was defined when creating the subnet pool will be used if not provided. Changing this creates a new subnet.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnet. If omitted, the region argument of the provider is used. Changing this creates a new subnet.

property subnetpoolId

subnetpoolId?: pulumi.Input<string>;

The ID of the subnetpool associated with the subnet.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the subnet.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the subnet. Required if admin wants to create a subnet for another tenant. Changing this creates a new subnet.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface SubnetPoolArgs

interface SubnetPoolArgs

The set of arguments for constructing a SubnetPool resource.

property addressScopeId

addressScopeId?: pulumi.Input<string>;

The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.

property defaultPrefixlen

defaultPrefixlen?: pulumi.Input<number>;

The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.

property defaultQuota

defaultQuota?: pulumi.Input<number>;

The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.

property description

description?: pulumi.Input<string>;

The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.

property ipVersion

ipVersion?: pulumi.Input<number>;

The IP protocol version.

property isDefault

isDefault?: pulumi.Input<boolean>;

Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.

property maxPrefixlen

maxPrefixlen?: pulumi.Input<number>;

The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.

property minPrefixlen

minPrefixlen?: pulumi.Input<number>;

The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.

property name

name?: pulumi.Input<string>;

The name of the subnetpool. Changing this updates the name of the existing subnetpool.

property prefixes

prefixes: pulumi.Input<pulumi.Input<string>[]>;

A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.

property projectId

projectId?: pulumi.Input<string>;

The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.

property shared

shared?: pulumi.Input<boolean>;

Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the subnetpool.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface SubnetPoolState

interface SubnetPoolState

Input properties used for looking up and filtering SubnetPool resources.

property addressScopeId

addressScopeId?: pulumi.Input<string>;

The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.

property allTags

allTags?: pulumi.Input<pulumi.Input<string>[]>;

The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.

property createdAt

createdAt?: pulumi.Input<string>;

The time at which subnetpool was created.

property defaultPrefixlen

defaultPrefixlen?: pulumi.Input<number>;

The size of the prefix to allocate when the cidr or prefixlen attributes are omitted when you create the subnet. Defaults to the MinPrefixLen. Changing this updates the default prefixlen of the existing subnetpool.

property defaultQuota

defaultQuota?: pulumi.Input<number>;

The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets. Changing this updates the default quota of the existing subnetpool.

property description

description?: pulumi.Input<string>;

The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.

property ipVersion

ipVersion?: pulumi.Input<number>;

The IP protocol version.

property isDefault

isDefault?: pulumi.Input<boolean>;

Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.

property maxPrefixlen

maxPrefixlen?: pulumi.Input<number>;

The maximum prefix size that can be allocated from the subnetpool. For IPv4 subnetpools, default is 32. For IPv6 subnetpools, default is 128. Changing this updates the max prefixlen of the existing subnetpool.

property minPrefixlen

minPrefixlen?: pulumi.Input<number>;

The smallest prefix that can be allocated from a subnetpool. For IPv4 subnetpools, default is 8. For IPv6 subnetpools, default is 64. Changing this updates the min prefixlen of the existing subnetpool.

property name

name?: pulumi.Input<string>;

The name of the subnetpool. Changing this updates the name of the existing subnetpool.

property prefixes

prefixes?: pulumi.Input<pulumi.Input<string>[]>;

A list of subnet prefixes to assign to the subnetpool. Neutron API merges adjacent prefixes and treats them as a single prefix. Each subnet prefix must be unique among all subnet prefixes in all subnetpools that are associated with the address scope. Changing this updates the prefixes list of the existing subnetpool.

property projectId

projectId?: pulumi.Input<string>;

The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the region argument of the provider is used. Changing this creates a new subnetpool.

property revisionNumber

revisionNumber?: pulumi.Input<number>;

The revision number of the subnetpool.

property shared

shared?: pulumi.Input<boolean>;

Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the subnetpool.

property updatedAt

updatedAt?: pulumi.Input<string>;

The time at which subnetpool was created.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface SubnetRouteArgs

interface SubnetRouteArgs

The set of arguments for constructing a SubnetRoute resource.

property destinationCidr

destinationCidr: pulumi.Input<string>;

CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.

property nextHop

nextHop: pulumi.Input<string>;

IP address of the next hop gateway. Changing this creates a new routing entry.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

property subnetId

subnetId: pulumi.Input<string>;

ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.

interface SubnetRouteState

interface SubnetRouteState

Input properties used for looking up and filtering SubnetRoute resources.

property destinationCidr

destinationCidr?: pulumi.Input<string>;

CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.

property nextHop

nextHop?: pulumi.Input<string>;

IP address of the next hop gateway. Changing this creates a new routing entry.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

property subnetId

subnetId?: pulumi.Input<string>;

ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.

interface SubnetState

interface SubnetState

Input properties used for looking up and filtering Subnet resources.

property allTags

allTags?: pulumi.Input<pulumi.Input<string>[]>;

The collection of ags assigned on the subnet, which have been explicitly and implicitly added.

property allocationPools

allocationPools?: pulumi.Input<pulumi.Input<SubnetAllocationPool>[]>;

A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. Multiple allocationPool blocks can be declared, providing the subnet with more than one range of IP addresses to use with DHCP. However, each IP range must be from the same CIDR that the subnet is part of. The allocationPool block is documented below.

property allocationPoolsCollection

DEPRECATED use allocation_pool instead
allocationPoolsCollection?: pulumi.Input<pulumi.Input<SubnetAllocationPoolsCollection>[]>;

A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. The allocationPools block is documented below.

property cidr

cidr?: pulumi.Input<string>;

CIDR representing IP range for this subnet, based on IP version. You can omit this option if you are creating a subnet from a subnet pool.

property description

description?: pulumi.Input<string>;

Human-readable description of the subnet. Changing this updates the name of the existing subnet.

property dnsNameservers

dnsNameservers?: pulumi.Input<pulumi.Input<string>[]>;

An array of DNS name server names used by hosts in this subnet. Changing this updates the DNS name servers for the existing subnet.

property enableDhcp

enableDhcp?: pulumi.Input<boolean>;

The administrative state of the network. Acceptable values are “true” and “false”. Changing this value enables or disables the DHCP capabilities of the existing subnet. Defaults to true.

property gatewayIp

gatewayIp?: pulumi.Input<string>;

Default gateway used by devices in this subnet. Leaving this blank and not setting noGateway will cause a default gateway of .1 to be used. Changing this updates the gateway IP of the existing subnet.

property hostRoutes

DEPRECATED Use openstack_networking_subnet_route_v2 instead
hostRoutes?: pulumi.Input<pulumi.Input<SubnetHostRoute>[]>;

(Deprecated - use openstack.networking.SubnetRoute instead) An array of routes that should be used by devices with IPs from this subnet (not including local subnet route). The hostRoute object structure is documented below. Changing this updates the host routes for the existing subnet.

property ipVersion

ipVersion?: pulumi.Input<number>;

IP version, either 4 (default) or 6. Changing this creates a new subnet.

property ipv6AddressMode

ipv6AddressMode?: pulumi.Input<string>;

The IPv6 address mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.

property ipv6RaMode

ipv6RaMode?: pulumi.Input<string>;

The IPv6 Router Advertisement mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.

property name

name?: pulumi.Input<string>;

The name of the subnet. Changing this updates the name of the existing subnet.

property networkId

networkId?: pulumi.Input<string>;

The UUID of the parent network. Changing this creates a new subnet.

property noGateway

noGateway?: pulumi.Input<boolean>;

Do not set a gateway IP on this subnet. Changing this removes or adds a default gateway IP of the existing subnet.

property prefixLength

prefixLength?: pulumi.Input<number>;

The prefix length to use when creating a subnet from a subnet pool. The default subnet pool prefix length that was defined when creating the subnet pool will be used if not provided. Changing this creates a new subnet.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnet. If omitted, the region argument of the provider is used. Changing this creates a new subnet.

property subnetpoolId

subnetpoolId?: pulumi.Input<string>;

The ID of the subnetpool associated with the subnet.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the subnet.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the subnet. Required if admin wants to create a subnet for another tenant. Changing this creates a new subnet.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options.

interface TrunkArgs

interface TrunkArgs

The set of arguments for constructing a Trunk resource.

property adminStateUp

adminStateUp?: pulumi.Input<boolean>;

Administrative up/down status for the trunk (must be “true” or “false” if provided). Changing this updates the adminStateUp of an existing trunk.

property description

description?: pulumi.Input<string>;

Human-readable description of the trunk. Changing this updates the name of the existing trunk.

property name

name?: pulumi.Input<string>;

A unique name for the trunk. Changing this updates the name of an existing trunk.

property portId

portId: pulumi.Input<string>;

The ID of the port to be made a subport of the trunk.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a trunk. If omitted, the region argument of the provider is used. Changing this creates a new trunk.

property subPorts

subPorts?: pulumi.Input<pulumi.Input<TrunkSubPort>[]>;

The set of ports that will be made subports of the trunk. The structure of each subport is described below.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the port.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the Trunk. Required if admin wants to create a trunk on behalf of another tenant. Changing this creates a new trunk.

interface TrunkState

interface TrunkState

Input properties used for looking up and filtering Trunk resources.

property adminStateUp

adminStateUp?: pulumi.Input<boolean>;

Administrative up/down status for the trunk (must be “true” or “false” if provided). Changing this updates the adminStateUp of an existing trunk.

property allTags

allTags?: pulumi.Input<pulumi.Input<string>[]>;

The collection of tags assigned on the trunk, which have been explicitly and implicitly added.

property description

description?: pulumi.Input<string>;

Human-readable description of the trunk. Changing this updates the name of the existing trunk.

property name

name?: pulumi.Input<string>;

A unique name for the trunk. Changing this updates the name of an existing trunk.

property portId

portId?: pulumi.Input<string>;

The ID of the port to be made a subport of the trunk.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 networking client. A networking client is needed to create a trunk. If omitted, the region argument of the provider is used. Changing this creates a new trunk.

property subPorts

subPorts?: pulumi.Input<pulumi.Input<TrunkSubPort>[]>;

The set of ports that will be made subports of the trunk. The structure of each subport is described below.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A set of string tags for the port.

property tenantId

tenantId?: pulumi.Input<string>;

The owner of the Trunk. Required if admin wants to create a trunk on behalf of another tenant. Changing this creates a new trunk.