networking

class pulumi_openstack.networking.AddressScope(resource_name, opts=None, ip_version=None, name=None, project_id=None, region=None, shared=None, __name__=None, __opts__=None)

Manages a V2 Neutron addressscope resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • ip_version (pulumi.Input[float]) – IP version, either 4 (default) or 6. Changing this creates a new address-scope.
  • name (pulumi.Input[str]) – The name of the address-scope. Changing this updates the name of the existing address-scope.
  • project_id (pulumi.Input[str]) – 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.
  • region (pulumi.Input[str]) – 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.
  • shared (pulumi.Input[bool]) – Indicates whether this address-scope is shared across all projects. Changing this updates the shared status of the existing address-scope.
ip_version = None

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

name = None

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

project_id = None

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.

region = None

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.

shared = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.FloatingIp(resource_name, opts=None, address=None, description=None, dns_domain=None, dns_name=None, fixed_ip=None, pool=None, port_id=None, region=None, subnet_id=None, tags=None, tenant_id=None, value_specs=None, __name__=None, __opts__=None)

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.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • address (pulumi.Input[str]) – 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.
  • description (pulumi.Input[str]) – Human-readable description for the floating IP.
  • dns_domain (pulumi.Input[str]) – 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.
  • dns_name (pulumi.Input[str]) – 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.
  • fixed_ip (pulumi.Input[str]) – Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
  • pool (pulumi.Input[str]) – The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
  • port_id (pulumi.Input[str]) – ID of an existing port with at least one IP address to associate with this floating IP.
  • region (pulumi.Input[str]) – 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).
  • subnet_id (pulumi.Input[str]) – The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
  • tags (pulumi.Input[list]) – A set of string tags for the floating IP.
  • tenant_id (pulumi.Input[str]) – 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)
  • value_specs (pulumi.Input[dict]) – Map of additional options.
address = None

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.

all_tags = None

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

description = None

Human-readable description for the floating IP.

dns_domain = None

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.

dns_name = None

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.

fixed_ip = None

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

pool = None

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

port_id = None

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

region = None

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).

subnet_id = None

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

tags = None

A set of string tags for the floating IP.

tenant_id = None

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)

value_specs = None

Map of additional options.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.FloatingIpAssociate(resource_name, opts=None, fixed_ip=None, floating_ip=None, port_id=None, region=None, __name__=None, __opts__=None)

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_v2 resource to create a floating IP.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • floating_ip (pulumi.Input[str]) – IP Address of an existing floating IP.
  • port_id (pulumi.Input[str]) – ID of an existing port with at least one IP address to associate with this floating IP.
  • region (pulumi.Input[str]) – 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).
floating_ip = None

IP Address of an existing floating IP.

port_id = None

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

region = None

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).

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.GetFloatingIpResult(address=None, all_tags=None, description=None, dns_domain=None, dns_name=None, fixed_ip=None, pool=None, port_id=None, region=None, status=None, tags=None, tenant_id=None, id=None)

A collection of values returned by getFloatingIp.

all_tags = None

A set of string tags applied on the floating IP.

dns_domain = None

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

dns_name = None

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

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.networking.GetNetworkResult(admin_state_up=None, all_tags=None, availability_zone_hints=None, description=None, dns_domain=None, external=None, matching_subnet_cidr=None, mtu=None, name=None, network_id=None, region=None, shared=None, status=None, tags=None, tenant_id=None, transparent_vlan=None, id=None)

A collection of values returned by getNetwork.

admin_state_up = None

The administrative state of the network.

all_tags = None

The set of string tags applied on the network.

availability_zone_hints = None

The availability zone candidates for the network.

description = None

See Argument Reference above.

dns_domain = None

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

external = None

See Argument Reference above.

mtu = None

See Argument Reference above.

name = None

See Argument Reference above.

region = None

See Argument Reference above.

shared = None

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

transparent_vlan = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.networking.GetPortIdsResult(admin_state_up=None, description=None, device_id=None, device_owner=None, dns_name=None, fixed_ip=None, ids=None, mac_address=None, name=None, network_id=None, project_id=None, region=None, security_group_ids=None, sort_direction=None, sort_key=None, status=None, tags=None, tenant_id=None, id=None)

A collection of values returned by getPortIds.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.networking.GetPortResult(admin_state_up=None, all_fixed_ips=None, all_security_group_ids=None, all_tags=None, allowed_address_pairs=None, bindings=None, description=None, device_id=None, device_owner=None, dns_assignments=None, dns_name=None, extra_dhcp_options=None, fixed_ip=None, mac_address=None, name=None, network_id=None, port_id=None, project_id=None, region=None, security_group_ids=None, status=None, tags=None, tenant_id=None, id=None)

A collection of values returned by getPort.

admin_state_up = None

See Argument Reference above.

all_fixed_ips = None

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

all_security_group_ids = None

The set of security group IDs applied on the port.

all_tags = None

The set of string tags applied on the port.

allowed_address_pairs = None

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

bindings = None

The port binding information. The structure is described below.

description = None

See Argument Reference above.

device_id = None

See Argument Reference above.

device_owner = None

See Argument Reference above.

dns_assignments = None

The list of maps representing port DNS assignments.

dns_name = None

See Argument Reference above.

extra_dhcp_options = None

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

mac_address = None

The additional MAC address.

name = None

Name of the DHCP option.

network_id = None

See Argument Reference above.

port_id = None

See Argument Reference above.

project_id = None

See Argument Reference above.

region = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.networking.GetRouterResult(admin_state_up=None, all_tags=None, availability_zone_hints=None, description=None, distributed=None, enable_snat=None, external_fixed_ips=None, external_network_id=None, name=None, region=None, router_id=None, status=None, tags=None, tenant_id=None, id=None)

A collection of values returned by getRouter.

all_tags = None

The set of string tags applied on the router.

availability_zone_hints = None

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

enable_snat = None

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

external_fixed_ips = None

The external fixed IPs of the router.

external_network_id = None

The network UUID of an external gateway for the router.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.networking.GetSecGroupResult(all_tags=None, description=None, name=None, region=None, secgroup_id=None, tags=None, tenant_id=None, id=None)

A collection of values returned by getSecGroup.

all_tags = None

The set of string tags applied on the security group.

name = None

See Argument Reference above.

  • description- See Argument Reference above.
region = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.networking.GetSubnetPoolResult(address_scope_id=None, all_tags=None, created_at=None, default_prefixlen=None, default_quota=None, description=None, ip_version=None, is_default=None, max_prefixlen=None, min_prefixlen=None, name=None, prefixes=None, project_id=None, region=None, revision_number=None, shared=None, tags=None, updated_at=None, id=None)

A collection of values returned by getSubnetPool.

address_scope_id = None

See Argument Reference above.

  • ip_version -The IP protocol version.
all_tags = None

The set of string tags applied on the subnetpool.

created_at = None

The time at which subnetpool was created.

default_prefixlen = None

See Argument Reference above.

default_quota = None

See Argument Reference above.

description = None

See Argument Reference above.

is_default = None

See Argument Reference above.

max_prefixlen = None

See Argument Reference above.

min_prefixlen = None

See Argument Reference above.

name = None

See Argument Reference above.

prefixes = None

See Argument Reference above.

project_id = None

See Argument Reference above.

region = None

See Argument Reference above.

revision_number = None

The revision number of the subnetpool.

shared = None

See Argument Reference above.

updated_at = None

The time at which subnetpool was created.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.networking.GetSubnetResult(all_tags=None, allocation_pools=None, cidr=None, description=None, dhcp_disabled=None, dhcp_enabled=None, dns_nameservers=None, enable_dhcp=None, gateway_ip=None, host_routes=None, ip_version=None, ipv6_address_mode=None, ipv6_ra_mode=None, name=None, network_id=None, region=None, subnet_id=None, subnetpool_id=None, tags=None, tenant_id=None, id=None)

A collection of values returned by getSubnet.

all_tags = None

A set of string tags applied on the subnet.

allocation_pools = None

Allocation pools of the subnet.

dns_nameservers = None

DNS Nameservers of the subnet.

enable_dhcp = None

Whether the subnet has DHCP enabled or not.

host_routes = None

Host Routes of the subnet.

region = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.networking.GetTrunkResult(admin_state_up=None, all_tags=None, description=None, name=None, port_id=None, project_id=None, region=None, status=None, sub_ports=None, tags=None, trunk_id=None, id=None)

A collection of values returned by getTrunk.

all_tags = None

The set of string tags applied on the trunk.

port_id = None

The ID of the trunk subport.

sub_ports = None

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

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.networking.Network(resource_name, opts=None, admin_state_up=None, availability_zone_hints=None, description=None, dns_domain=None, external=None, mtu=None, name=None, port_security_enabled=None, region=None, segments=None, shared=None, tags=None, tenant_id=None, transparent_vlan=None, value_specs=None, __name__=None, __opts__=None)

Manages a V2 Neutron network resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[bool]) – The administrative state of the network. Acceptable values are “true” and “false”. Changing this value updates the state of the existing network.
  • availability_zone_hints (pulumi.Input[list]) – 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.
  • description (pulumi.Input[str]) – Human-readable description of the network. Changing this updates the name of the existing network.
  • dns_domain (pulumi.Input[str]) – The network DNS domain. Available, when Neutron DNS extension is enabled. The dns_domain of a network in conjunction with the dns_name attribute of its ports will be published in an external DNS service when Neutron is configured to integrate with such a service.
  • external (pulumi.Input[bool]) – 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.
  • mtu (pulumi.Input[float]) – 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.
  • name (pulumi.Input[str]) – The name of the network. Changing this updates the name of the existing network.
  • port_security_enabled (pulumi.Input[bool]) – 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.
  • region (pulumi.Input[str]) – 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.
  • segments (pulumi.Input[list]) – An array of one or more provider segment objects.
  • shared (pulumi.Input[bool]) – Specifies whether the network resource can be accessed by any tenant or not. Changing this updates the sharing capabilities of the existing network.
  • tags (pulumi.Input[list]) – A set of string tags for the network.
  • tenant_id (pulumi.Input[str]) – The owner of the network. Required if admin wants to create a network for another tenant. Changing this creates a new network.
  • transparent_vlan (pulumi.Input[bool]) – Specifies whether the network resource has the VLAN transparent attribute set. Valid values are true and false. Defaults to false. Changing this updates the transparent_vlan attribute of the existing network.
  • value_specs (pulumi.Input[dict]) – Map of additional options.
admin_state_up = None

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

all_tags = None

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

availability_zone_hints = None

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.

description = None

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

dns_domain = None

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

external = None

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.

mtu = None

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.

name = None

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

port_security_enabled = None

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.

region = None

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.

segments = None

An array of one or more provider segment objects.

shared = None

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

tags = None

A set of string tags for the network.

tenant_id = None

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

transparent_vlan = None

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

value_specs = None

Map of additional options.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.Port(resource_name, opts=None, admin_state_up=None, allowed_address_pairs=None, binding=None, description=None, device_id=None, device_owner=None, dns_name=None, extra_dhcp_options=None, fixed_ips=None, mac_address=None, name=None, network_id=None, no_fixed_ip=None, no_security_groups=None, port_security_enabled=None, region=None, security_group_ids=None, tags=None, tenant_id=None, value_specs=None, __name__=None, __opts__=None)

Manages a V2 port resource within OpenStack.

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[bool]) – Administrative up/down status for the port (must be “true” or “false” if provided). Changing this updates the admin_state_up of an existing port.
  • allowed_address_pairs (pulumi.Input[list]) – An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
  • binding (pulumi.Input[dict]) – The port binding allows to specify binding information for the port. The structure is described below.
  • description (pulumi.Input[str]) – Human-readable description of the floating IP. Changing this updates the description of an existing port.
  • device_id (pulumi.Input[str]) – The ID of the device attached to the port. Changing this creates a new port.
  • device_owner (pulumi.Input[str]) – The device owner of the Port. Changing this creates a new port.
  • dns_name (pulumi.Input[str]) – The port DNS name. Available, when Neutron DNS extension is enabled.
  • extra_dhcp_options (pulumi.Input[list]) – An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times.
  • fixed_ips (pulumi.Input[list]) – An array of desired IPs for this port. The structure is described below.
  • mac_address (pulumi.Input[str]) – Specify a specific MAC address for the port. Changing this creates a new port.
  • name (pulumi.Input[str]) – A unique name for the port. Changing this updates the name of an existing port.
  • network_id (pulumi.Input[str]) – The ID of the network to attach the port to. Changing this creates a new port.
  • no_fixed_ip (pulumi.Input[bool]) – 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.
  • no_security_groups (pulumi.Input[bool]) – If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the Port will yield to the default behavior of the Networking service, which is to usually apply the “default” security group.
  • port_security_enabled (pulumi.Input[bool]) – 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.
  • region (pulumi.Input[str]) – 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.
  • security_group_ids (pulumi.Input[list]) – 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).
  • tags (pulumi.Input[list]) – A set of string tags for the port.
  • tenant_id (pulumi.Input[str]) – The owner of the Port. Required if admin wants to create a port for another tenant. Changing this creates a new port.
  • value_specs (pulumi.Input[dict]) – Map of additional options.
admin_state_up = None

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

all_fixed_ips = None

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

all_security_group_ids = None

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

all_tags = None

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

allowed_address_pairs = None

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

binding = None

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

description = None

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

device_id = None

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

device_owner = None

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

dns_assignments = None

The list of maps representing port DNS assignments.

dns_name = None

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

extra_dhcp_options = None

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

fixed_ips = None

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

mac_address = None

Specify a specific MAC address for the port. Changing this creates a new port.

name = None

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

network_id = None

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

no_fixed_ip = None

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.

no_security_groups = None

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

port_security_enabled = None

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.

region = None

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.

security_group_ids = None

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).

tags = None

A set of string tags for the port.

tenant_id = None

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

value_specs = None

Map of additional options.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.PortSecGroupAssociate(resource_name, opts=None, enforce=None, port_id=None, region=None, security_group_ids=None, __name__=None, __opts__=None)

Manages a V2 port’s security groups within OpenStack. Useful, when the port was created not by Terraform (e.g. Manila or LBaaS). It should not be used, when the port was created directly within Terraform.

When the resource is deleted, Terraform doesn’t delete the port, but unsets the list of user defined security group IDs. However, if enforce is set to true and the resource is deleted, Terraform will remove all assigned security group IDs.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • enforce (pulumi.Input[bool]) – Whether to replace or append the list of security groups, specified in the security_group_ids. Defaults to false.
  • port_id (pulumi.Input[str]) – An UUID of the port to apply security groups to.
  • region (pulumi.Input[str]) – 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.
  • security_group_ids (pulumi.Input[list]) – 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).
all_security_group_ids = None

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

enforce = None

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

port_id = None

An UUID of the port to apply security groups to.

region = None

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.

security_group_ids = None

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).

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.Router(resource_name, opts=None, admin_state_up=None, availability_zone_hints=None, description=None, distributed=None, enable_snat=None, external_fixed_ips=None, external_gateway=None, external_network_id=None, name=None, region=None, tags=None, tenant_id=None, value_specs=None, vendor_options=None, __name__=None, __opts__=None)

Manages a V2 router resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[bool]) – Administrative up/down status for the router (must be “true” or “false” if provided). Changing this updates the admin_state_up of an existing router.
  • availability_zone_hints (pulumi.Input[list]) – 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.
  • description (pulumi.Input[str]) – Human-readable description for the router.
  • distributed (pulumi.Input[bool]) – Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
  • enable_snat (pulumi.Input[bool]) – Enable Source NAT for the router. Valid values are “true” or “false”. An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router.
  • external_fixed_ips (pulumi.Input[list]) – An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
  • external_gateway (pulumi.Input[str]) – 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.
  • external_network_id (pulumi.Input[str]) – 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.
  • name (pulumi.Input[str]) – A unique name for the router. Changing this updates the name of an existing router.
  • region (pulumi.Input[str]) – 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.
  • tags (pulumi.Input[list]) – A set of string tags for the router.
  • tenant_id (pulumi.Input[str]) – The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
  • value_specs (pulumi.Input[dict]) – Map of additional driver-specific options.
  • vendor_options (pulumi.Input[dict]) – Map of additional vendor-specific options. Supported options are described below.
admin_state_up = None

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

all_tags = None

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

availability_zone_hints = None

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.

description = None

Human-readable description for the router.

distributed = None

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

enable_snat = None

Enable Source NAT for the router. Valid values are “true” or “false”. An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router.

external_fixed_ips = None

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

external_gateway = None

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.

external_network_id = None

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.

name = None

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

region = None

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.

tags = None

A set of string tags for the router.

tenant_id = None

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

value_specs = None

Map of additional driver-specific options.

vendor_options = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.RouterInterface(resource_name, opts=None, port_id=None, region=None, router_id=None, subnet_id=None, __name__=None, __opts__=None)

Manages a V2 router interface resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • port_id (pulumi.Input[str]) – ID of the port this interface connects to. Changing this creates a new router interface.
  • region (pulumi.Input[str]) – 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.
  • router_id (pulumi.Input[str]) – ID of the router this interface belongs to. Changing this creates a new router interface.
  • subnet_id (pulumi.Input[str]) – ID of the subnet this interface connects to. Changing this creates a new router interface.
port_id = None

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

region = None

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.

router_id = None

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

subnet_id = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.RouterRoute(resource_name, opts=None, destination_cidr=None, next_hop=None, region=None, router_id=None, __name__=None, __opts__=None)

Creates a routing entry on a OpenStack V2 router.

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • destination_cidr (pulumi.Input[str]) – CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
  • next_hop (pulumi.Input[str]) – IP address of the next hop gateway. Changing this creates a new routing entry.
  • region (pulumi.Input[str]) – 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.
  • router_id (pulumi.Input[str]) – ID of the router this routing entry belongs to. Changing this creates a new routing entry.
destination_cidr = None

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

next_hop = None

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

region = None

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.

router_id = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.SecGroup(resource_name, opts=None, delete_default_rules=None, description=None, name=None, region=None, tags=None, tenant_id=None, __name__=None, __opts__=None)

Manages a V2 neutron security group 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.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • delete_default_rules (pulumi.Input[bool]) – Whether or not to delete the default egress security rules. This is false by default. See the below note for more information.
  • description (pulumi.Input[str]) – A unique name for the security group.
  • name (pulumi.Input[str]) – A unique name for the security group.
  • region (pulumi.Input[str]) – 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.
  • tags (pulumi.Input[list]) – A set of string tags for the security group.
  • tenant_id (pulumi.Input[str]) – The owner of the security group. Required if admin wants to create a port for another tenant. Changing this creates a new security group.
all_tags = None

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

delete_default_rules = None

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

description = None

A unique name for the security group.

name = None

A unique name for the security group.

region = None

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.

tags = None

A set of string tags for the security group.

tenant_id = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.SecGroupRule(resource_name, opts=None, description=None, direction=None, ethertype=None, port_range_max=None, port_range_min=None, protocol=None, region=None, remote_group_id=None, remote_ip_prefix=None, security_group_id=None, tenant_id=None, __name__=None, __opts__=None)

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.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – A description of the rule. Changing this creates a new security group rule.
  • direction (pulumi.Input[str]) – The direction of the rule, valid values are ingress or egress. Changing this creates a new security group rule.
  • ethertype (pulumi.Input[str]) – The layer 3 protocol type, valid values are IPv4 or IPv6. Changing this creates a new security group rule.
  • port_range_max (pulumi.Input[float]) – 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.
  • port_range_min (pulumi.Input[float]) – 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.
  • protocol (pulumi.Input[str]) – 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.
Parameters:
  • region (pulumi.Input[str]) – 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.
  • remote_group_id (pulumi.Input[str]) – 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.
  • remote_ip_prefix (pulumi.Input[str]) – 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.
  • security_group_id (pulumi.Input[str]) – 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.
  • tenant_id (pulumi.Input[str]) – 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.
description = None

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

direction = None

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

ethertype = None

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

port_range_max = None

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.

port_range_min = None

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.

protocol = None

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
region = None

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.

remote_group_id = None

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.

remote_ip_prefix = None

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.

security_group_id = None

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.

tenant_id = None

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.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.Subnet(resource_name, opts=None, allocation_pools=None, cidr=None, description=None, dns_nameservers=None, enable_dhcp=None, gateway_ip=None, host_routes=None, ip_version=None, ipv6_address_mode=None, ipv6_ra_mode=None, name=None, network_id=None, no_gateway=None, prefix_length=None, region=None, subnetpool_id=None, tags=None, tenant_id=None, value_specs=None, __name__=None, __opts__=None)

Manages a V2 Neutron subnet resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • allocation_pools (pulumi.Input[list]) – An array of sub-ranges of CIDR available for dynamic allocation to ports. The allocation_pool object structure is documented below. Changing this creates a new subnet.
  • cidr (pulumi.Input[str]) – 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.
  • description (pulumi.Input[str]) – Human-readable description of the subnet. Changing this updates the name of the existing subnet.
  • dns_nameservers (pulumi.Input[list]) – An array of DNS name server names used by hosts in this subnet. Changing this updates the DNS name servers for the existing subnet.
  • enable_dhcp (pulumi.Input[bool]) – 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.
  • gateway_ip (pulumi.Input[str]) – Default gateway used by devices in this subnet. Leaving this blank and not setting no_gateway will cause a default gateway of .1 to be used. Changing this updates the gateway IP of the existing subnet.
  • host_routes (pulumi.Input[list]) – (Deprecated - use openstack_networking_subnet_route_v2 instead) An array of routes that should be used by devices with IPs from this subnet (not including local subnet route). The host_route object structure is documented below. Changing this updates the host routes for the existing subnet.
  • ip_version (pulumi.Input[float]) – IP version, either 4 (default) or 6. Changing this creates a new subnet.
  • ipv6_address_mode (pulumi.Input[str]) – The IPv6 address mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.
  • ipv6_ra_mode (pulumi.Input[str]) – The IPv6 Router Advertisement mode. Valid values are dhcpv6-stateful, dhcpv6-stateless, or slaac.
  • name (pulumi.Input[str]) – The name of the subnet. Changing this updates the name of the existing subnet.
  • network_id (pulumi.Input[str]) – The UUID of the parent network. Changing this creates a new subnet.
  • no_gateway (pulumi.Input[bool]) – Do not set a gateway IP on this subnet. Changing this removes or adds a default gateway IP of the existing subnet.
  • prefix_length (pulumi.Input[float]) – 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.
  • region (pulumi.Input[str]) – 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.
  • subnetpool_id (pulumi.Input[str]) – The ID of the subnetpool associated with the subnet.
  • tags (pulumi.Input[list]) – A set of string tags for the subnet.
  • tenant_id (pulumi.Input[str]) – The owner of the subnet. Required if admin wants to create a subnet for another tenant. Changing this creates a new subnet.
  • value_specs (pulumi.Input[dict]) – Map of additional options.
all_tags = None

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

allocation_pools = None

An array of sub-ranges of CIDR available for dynamic allocation to ports. The allocation_pool object structure is documented below. Changing this creates a new subnet.

cidr = None

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.

description = None

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

dns_nameservers = None

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

enable_dhcp = None

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.

gateway_ip = None

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

host_routes = None

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

ip_version = None

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

ipv6_address_mode = None

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

ipv6_ra_mode = None

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

name = None

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

network_id = None

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

no_gateway = None

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

prefix_length = None

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.

region = None

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.

subnetpool_id = None

The ID of the subnetpool associated with the subnet.

tags = None

A set of string tags for the subnet.

tenant_id = None

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

value_specs = None

Map of additional options.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.SubnetPool(resource_name, opts=None, address_scope_id=None, default_prefixlen=None, default_quota=None, description=None, ip_version=None, is_default=None, max_prefixlen=None, min_prefixlen=None, name=None, prefixes=None, project_id=None, region=None, shared=None, tags=None, value_specs=None, __name__=None, __opts__=None)

Manages a V2 Neutron subnetpool resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • address_scope_id (pulumi.Input[str]) – The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
  • default_prefixlen (pulumi.Input[float]) – 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.
  • default_quota (pulumi.Input[float]) – 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.
  • description (pulumi.Input[str]) – The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
  • ip_version (pulumi.Input[float]) – The IP protocol version.
  • is_default (pulumi.Input[bool]) – Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
  • max_prefixlen (pulumi.Input[float]) – 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.
  • min_prefixlen (pulumi.Input[float]) – 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.
  • name (pulumi.Input[str]) – The name of the subnetpool. Changing this updates the name of the existing subnetpool.
  • prefixes (pulumi.Input[list]) – 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.
  • project_id (pulumi.Input[str]) – The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
  • region (pulumi.Input[str]) – 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.
  • shared (pulumi.Input[bool]) – Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
  • tags (pulumi.Input[list]) – A set of string tags for the subnetpool.
  • value_specs (pulumi.Input[dict]) – Map of additional options.
address_scope_id = None

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

all_tags = None

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

created_at = None

The time at which subnetpool was created.

default_prefixlen = None

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.

default_quota = None

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.

description = None

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

ip_version = None

The IP protocol version.

is_default = None

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

max_prefixlen = None

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.

min_prefixlen = None

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.

name = None

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

prefixes = None

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.

project_id = None

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

region = None

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.

revision_number = None

The revision number of the subnetpool.

shared = None

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

tags = None

A set of string tags for the subnetpool.

updated_at = None

The time at which subnetpool was created.

value_specs = None

Map of additional options.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.SubnetRoute(resource_name, opts=None, destination_cidr=None, next_hop=None, region=None, subnet_id=None, __name__=None, __opts__=None)

Creates a routing entry on a OpenStack V2 subnet.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • destination_cidr (pulumi.Input[str]) – CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
  • next_hop (pulumi.Input[str]) – IP address of the next hop gateway. Changing this creates a new routing entry.
  • region (pulumi.Input[str]) – 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.
  • subnet_id (pulumi.Input[str]) – ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.
destination_cidr = None

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

next_hop = None

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

region = None

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.

subnet_id = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.networking.Trunk(resource_name, opts=None, admin_state_up=None, description=None, name=None, port_id=None, region=None, sub_ports=None, tags=None, tenant_id=None, __name__=None, __opts__=None)

Manages a networking V2 trunk resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • admin_state_up (pulumi.Input[bool]) – Administrative up/down status for the trunk (must be “true” or “false” if provided). Changing this updates the admin_state_up of an existing trunk.
  • description (pulumi.Input[str]) – Human-readable description of the trunk. Changing this updates the name of the existing trunk.
  • name (pulumi.Input[str]) – A unique name for the trunk. Changing this updates the name of an existing trunk.
  • port_id (pulumi.Input[str]) – The ID of the port to be used as the parent port of the trunk. This is the port that should be used as the compute instance network port. Changing this creates a new trunk.
  • region (pulumi.Input[str]) – 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.
  • sub_ports (pulumi.Input[list]) – The set of ports that will be made subports of the trunk. The structure of each subport is described below.
  • tags (pulumi.Input[list]) – A set of string tags for the port.
  • tenant_id (pulumi.Input[str]) – The owner of the Trunk. Required if admin wants to create a trunk on behalf of another tenant. Changing this creates a new trunk.
admin_state_up = None

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

all_tags = None

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

description = None

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

name = None

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

port_id = None

The ID of the port to be used as the parent port of the trunk. This is the port that should be used as the compute instance network port. Changing this creates a new trunk.

region = None

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.

sub_ports = None

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

tags = None

A set of string tags for the port.

tenant_id = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_openstack.networking.get_floating_ip(address=None, description=None, fixed_ip=None, pool=None, port_id=None, region=None, status=None, tags=None, tenant_id=None, opts=None)

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

pulumi_openstack.networking.get_network(description=None, external=None, matching_subnet_cidr=None, mtu=None, name=None, network_id=None, region=None, status=None, tags=None, tenant_id=None, transparent_vlan=None, opts=None)

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

pulumi_openstack.networking.get_port(admin_state_up=None, description=None, device_id=None, device_owner=None, dns_name=None, fixed_ip=None, mac_address=None, name=None, network_id=None, port_id=None, project_id=None, region=None, security_group_ids=None, status=None, tags=None, tenant_id=None, opts=None)

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

pulumi_openstack.networking.get_port_ids(admin_state_up=None, description=None, device_id=None, device_owner=None, dns_name=None, fixed_ip=None, mac_address=None, name=None, network_id=None, project_id=None, region=None, security_group_ids=None, sort_direction=None, sort_key=None, status=None, tags=None, tenant_id=None, opts=None)

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

pulumi_openstack.networking.get_router(admin_state_up=None, description=None, distributed=None, enable_snat=None, name=None, region=None, router_id=None, status=None, tags=None, tenant_id=None, opts=None)

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

pulumi_openstack.networking.get_sec_group(description=None, name=None, region=None, secgroup_id=None, tags=None, tenant_id=None, opts=None)

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

pulumi_openstack.networking.get_subnet(cidr=None, description=None, dhcp_disabled=None, dhcp_enabled=None, gateway_ip=None, ip_version=None, ipv6_address_mode=None, ipv6_ra_mode=None, name=None, network_id=None, region=None, subnet_id=None, subnetpool_id=None, tags=None, tenant_id=None, opts=None)

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

pulumi_openstack.networking.get_subnet_pool(address_scope_id=None, default_prefixlen=None, default_quota=None, description=None, ip_version=None, is_default=None, max_prefixlen=None, min_prefixlen=None, name=None, project_id=None, region=None, shared=None, tags=None, opts=None)

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

pulumi_openstack.networking.get_trunk(admin_state_up=None, description=None, name=None, port_id=None, project_id=None, region=None, status=None, tags=None, trunk_id=None, opts=None)

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