This page documents the language specification for the openstack package. If you're looking for help working with the inputs, outputs, or functions of openstack resources in a Pulumi program, please see the resource documentation for examples and API reference.
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.
- class
pulumi_openstack.networking.AddressScope(resource_name, opts=None, ip_version=None, name=None, project_id=None, region=None, shared=None, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 Neutron addressscope resource within OpenStack.
import pulumi import pulumi_openstack as openstack addressscope1 = openstack.networking.AddressScope("addressscope1", ip_version=6)
import pulumi import pulumi_openstack as openstack addressscope1 = openstack.networking.AddressScope("addressscope1", ip_version=6) subnetpool1 = openstack.networking.SubnetPool("subnetpool1", address_scope_id=addressscope1.id, prefixes=[ "fdf7:b13d:dead:beef::/64", "fd65:86cc:a334:39b7::/64", ])
- 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
regionargument 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: pulumi.Output[float] = None¶IP version, either 4 (default) or 6. Changing this creates a new address-scope.
name: pulumi.Output[str] = None¶The name of the address-scope. Changing this updates the name of the existing address-scope.
project_id: pulumi.Output[str] = 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: pulumi.Output[str] = 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
regionargument of the provider is used. Changing this creates a new address-scope.
Indicates whether this address-scope is shared across all projects. Changing this updates the shared status of the existing address-scope.
- static
get(resource_name, id, opts=None, ip_version=None, name=None, project_id=None, region=None, shared=None)¶ Get an existing AddressScope resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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
regionargument 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.
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.AwaitableGetAddressScopeResult(id=None, ip_version=None, name=None, project_id=None, region=None, shared=None)¶
- class
pulumi_openstack.networking.AwaitableGetFloatingIpResult(address=None, all_tags=None, description=None, dns_domain=None, dns_name=None, fixed_ip=None, id=None, pool=None, port_id=None, region=None, status=None, tags=None, tenant_id=None)¶
- class
pulumi_openstack.networking.AwaitableGetNetworkResult(admin_state_up=None, all_tags=None, availability_zone_hints=None, description=None, dns_domain=None, external=None, id=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)¶
- class
pulumi_openstack.networking.AwaitableGetPortIdsResult(admin_state_up=None, description=None, device_id=None, device_owner=None, dns_name=None, fixed_ip=None, id=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)¶
- class
pulumi_openstack.networking.AwaitableGetPortResult(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, id=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)¶
- class
pulumi_openstack.networking.AwaitableGetQosBandwidthLimitRuleResult(direction=None, id=None, max_burst_kbps=None, max_kbps=None, qos_policy_id=None, region=None)¶
- class
pulumi_openstack.networking.AwaitableGetQosDscpMarkingRuleResult(dscp_mark=None, id=None, qos_policy_id=None, region=None)¶
- class
pulumi_openstack.networking.AwaitableGetQosMinimumBandwidthRuleResult(direction=None, id=None, min_kbps=None, qos_policy_id=None, region=None)¶
- class
pulumi_openstack.networking.AwaitableGetQosPolicyResult(all_tags=None, created_at=None, description=None, id=None, is_default=None, name=None, project_id=None, region=None, revision_number=None, shared=None, tags=None, updated_at=None)¶
- class
pulumi_openstack.networking.AwaitableGetRouterResult(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, id=None, name=None, region=None, router_id=None, status=None, tags=None, tenant_id=None)¶
- class
pulumi_openstack.networking.AwaitableGetSecGroupResult(all_tags=None, description=None, id=None, name=None, region=None, secgroup_id=None, tags=None, tenant_id=None)¶
- class
pulumi_openstack.networking.AwaitableGetSubnetPoolResult(address_scope_id=None, all_tags=None, created_at=None, default_prefixlen=None, default_quota=None, description=None, id=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)¶
- class
pulumi_openstack.networking.AwaitableGetSubnetResult(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, id=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)¶
- class
pulumi_openstack.networking.AwaitableGetTrunkResult(admin_state_up=None, all_tags=None, description=None, id=None, name=None, port_id=None, project_id=None, region=None, status=None, sub_ports=None, tags=None, trunk_id=None)¶
- 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, __props__=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.
import pulumi import pulumi_openstack as openstack floatip1 = openstack.networking.FloatingIp("floatip1", pool="public")
- 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
regionargument 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: pulumi.Output[str] = 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.
The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
description: pulumi.Output[str] = None¶Human-readable description for the floating IP.
dns_domain: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
pool: pulumi.Output[str] = None¶The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
port_id: pulumi.Output[str] = None¶ID of an existing port with at least one IP address to associate with this floating IP.
region: pulumi.Output[str] = 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
regionargument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
subnet_id: pulumi.Output[str] = None¶The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
A set of string tags for the floating IP.
tenant_id: pulumi.Output[str] = 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: pulumi.Output[dict] = None¶Map of additional options.
- static
get(resource_name, id, opts=None, address=None, all_tags=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)¶ Get an existing FloatingIp resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
all_tags (pulumi.Input[list]) – The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
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
regionargument 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.
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, __props__=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
networking.FloatingIpresource to create a floating IP.import pulumi import pulumi_openstack as openstack port1 = openstack.networking.Port("port1", network_id="a5bbd213-e1d3-49b6-aed1-9df60ea94b9a") fip1 = openstack.networking.FloatingIpAssociate("fip1", floating_ip="1.2.3.4", port_id=port1.id)
- 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
regionargument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
floating_ip: pulumi.Output[str] = None¶IP Address of an existing floating IP.
port_id: pulumi.Output[str] = None¶ID of an existing port with at least one IP address to associate with this floating IP.
region: pulumi.Output[str] = 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
regionargument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
- static
get(resource_name, id, opts=None, fixed_ip=None, floating_ip=None, port_id=None, region=None)¶ Get an existing FloatingIpAssociate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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
regionargument 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.GetAddressScopeResult(id=None, ip_version=None, name=None, project_id=None, region=None, shared=None)¶ A collection of values returned by getAddressScope.
id= None¶The provider-assigned unique ID for this managed resource.
ip_version= None¶See Argument Reference above.
name= None¶See Argument Reference above.
project_id= None¶See Argument Reference above.
See Argument Reference above.
- class
pulumi_openstack.networking.GetFloatingIpResult(address=None, all_tags=None, description=None, dns_domain=None, dns_name=None, fixed_ip=None, id=None, pool=None, port_id=None, region=None, status=None, tags=None, tenant_id=None)¶ A collection of values returned by getFloatingIp.
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¶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, id=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)¶ A collection of values returned by getNetwork.
admin_state_up= None¶The administrative state of the network.
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.
id= None¶The provider-assigned unique ID for this managed resource.
mtu= None¶See Argument Reference above.
name= None¶See Argument Reference above.
region= None¶See Argument Reference above.
Specifies whether the network resource can be accessed by any tenant or not.
transparent_vlan= None¶See Argument Reference above.
- class
pulumi_openstack.networking.GetPortIdsResult(admin_state_up=None, description=None, device_id=None, device_owner=None, dns_name=None, fixed_ip=None, id=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)¶ A collection of values returned by getPortIds.
id= None¶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, id=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)¶ 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.
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.
id= None¶The provider-assigned unique ID for this managed resource.
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.
- class
pulumi_openstack.networking.GetQosBandwidthLimitRuleResult(direction=None, id=None, max_burst_kbps=None, max_kbps=None, qos_policy_id=None, region=None)¶ A collection of values returned by getQosBandwidthLimitRule.
direction= None¶See Argument Reference above.
id= None¶The provider-assigned unique ID for this managed resource.
max_burst_kbps= None¶See Argument Reference above.
max_kbps= None¶See Argument Reference above.
qos_policy_id= None¶See Argument Reference above.
region= None¶See Argument Reference above.
- class
pulumi_openstack.networking.GetQosDscpMarkingRuleResult(dscp_mark=None, id=None, qos_policy_id=None, region=None)¶ A collection of values returned by getQosDscpMarkingRule.
dscp_mark= None¶See Argument Reference above.
id= None¶The provider-assigned unique ID for this managed resource.
qos_policy_id= None¶See Argument Reference above.
region= None¶See Argument Reference above.
- class
pulumi_openstack.networking.GetQosMinimumBandwidthRuleResult(direction=None, id=None, min_kbps=None, qos_policy_id=None, region=None)¶ A collection of values returned by getQosMinimumBandwidthRule.
id= None¶The provider-assigned unique ID for this managed resource.
min_kbps= None¶See Argument Reference above.
qos_policy_id= None¶See Argument Reference above.
region= None¶See Argument Reference above.
- class
pulumi_openstack.networking.GetQosPolicyResult(all_tags=None, created_at=None, description=None, id=None, is_default=None, name=None, project_id=None, region=None, revision_number=None, shared=None, tags=None, updated_at=None)¶ A collection of values returned by getQosPolicy.
The set of string tags applied on the QoS policy.
created_at= None¶The time at which QoS policy was created.
description= None¶See Argument Reference above.
id= None¶The provider-assigned unique ID for this managed resource.
is_default= None¶See Argument Reference above.
name= None¶See Argument Reference above.
region= None¶See Argument Reference above.
revision_number= None¶The revision number of the QoS policy.
See Argument Reference above.
updated_at= None¶The time at which QoS policy was created.
- 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, id=None, name=None, region=None, router_id=None, status=None, tags=None, tenant_id=None)¶ A collection of values returned by getRouter.
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¶The provider-assigned unique ID for this managed resource.
- class
pulumi_openstack.networking.GetSecGroupResult(all_tags=None, description=None, id=None, name=None, region=None, secgroup_id=None, tags=None, tenant_id=None)¶ A collection of values returned by getSecGroup.
The set of string tags applied on the security group.
id= None¶The provider-assigned unique ID for this managed resource.
name= None¶See Argument Reference above.
description- See Argument Reference above.
region= None¶See Argument Reference above.
- class
pulumi_openstack.networking.GetSubnetPoolResult(address_scope_id=None, all_tags=None, created_at=None, default_prefixlen=None, default_quota=None, description=None, id=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)¶ A collection of values returned by getSubnetPool.
address_scope_id= None¶See Argument Reference above.
ip_version-The IP protocol version.
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.
id= None¶The provider-assigned unique ID for this managed resource.
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.
See Argument Reference above.
updated_at= None¶The time at which subnetpool was created.
- 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, id=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)¶ A collection of values returned by getSubnet.
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.
id= None¶The provider-assigned unique ID for this managed resource.
region= None¶See Argument Reference above.
- class
pulumi_openstack.networking.GetTrunkResult(admin_state_up=None, all_tags=None, description=None, id=None, name=None, port_id=None, project_id=None, region=None, status=None, sub_ports=None, tags=None, trunk_id=None)¶ A collection of values returned by getTrunk.
The set of string tags applied on the trunk.
id= None¶The provider-assigned unique ID for this managed resource.
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.
- 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, qos_policy_id=None, region=None, segments=None, shared=None, tags=None, tenant_id=None, transparent_vlan=None, value_specs=None, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 Neutron network resource within OpenStack.
import pulumi import pulumi_openstack as openstack network1 = openstack.networking.Network("network1", admin_state_up="true") subnet1 = openstack.networking.Subnet("subnet1", cidr="192.168.199.0/24", ip_version=4, network_id=network1.id) secgroup1 = openstack.compute.SecGroup("secgroup1", description="a security group", rules=[{ "cidr": "0.0.0.0/0", "fromPort": 22, "ipProtocol": "tcp", "toPort": 22, }]) port1 = openstack.networking.Port("port1", admin_state_up="true", fixed_ips=[{ "ip_address": "192.168.199.10", "subnet_id": subnet1.id, }], network_id=network1.id, security_group_ids=[secgroup1.id]) instance1 = openstack.compute.Instance("instance1", networks=[{ "port": port1.id, }], security_groups=[secgroup1.name])
- 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_domainof a network in conjunction with thedns_nameattribute 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-mtuextension is enabled. Available for the modification, when Neutronnet-mtu-writableextension 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
falsewill disable port security. Valid values aretrueandfalse.qos_policy_id (pulumi.Input[str]) – Reference to the associated QoS policy.
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
regionargument 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_vlanattribute of the existing network.value_specs (pulumi.Input[dict]) – Map of additional options.
The segments object supports the following:
network_type(pulumi.Input[str]) - The type of physical network.physicalNetwork(pulumi.Input[str]) - The physical network where this network is implemented.segmentation_id(pulumi.Input[float]) - An isolated segment on the physical network.
admin_state_up: pulumi.Output[bool] = None¶The administrative state of the network. Acceptable values are “true” and “false”. Changing this value updates the state of the existing network.
The collection of tags assigned on the network, which have been explicitly and implicitly added.
availability_zone_hints: pulumi.Output[list] = 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: pulumi.Output[str] = None¶Human-readable description of the network. Changing this updates the name of the existing network.
dns_domain: pulumi.Output[str] = None¶The network DNS domain. Available, when Neutron DNS extension is enabled. The
dns_domainof a network in conjunction with thedns_nameattribute of its ports will be published in an external DNS service when Neutron is configured to integrate with such a service.
external: pulumi.Output[bool] = 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: pulumi.Output[float] = None¶The network MTU. Available for read-only, when Neutron
net-mtuextension is enabled. Available for the modification, when Neutronnet-mtu-writableextension is enabled.
name: pulumi.Output[str] = None¶The name of the network. Changing this updates the name of the existing network.
port_security_enabled: pulumi.Output[bool] = 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
falsewill disable port security. Valid values aretrueandfalse.
qos_policy_id: pulumi.Output[str] = None¶Reference to the associated QoS policy.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron network. If omitted, the
regionargument of the provider is used. Changing this creates a new network.
segments: pulumi.Output[list] = None¶An array of one or more provider segment objects.
network_type(str) - The type of physical network.physicalNetwork(str) - The physical network where this network is implemented.segmentation_id(float) - An isolated segment on the physical network.
Specifies whether the network resource can be accessed by any tenant or not. Changing this updates the sharing capabilities of the existing network.
A set of string tags for the network.
tenant_id: pulumi.Output[str] = 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: pulumi.Output[bool] = 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_vlanattribute of the existing network.
value_specs: pulumi.Output[dict] = None¶Map of additional options.
- static
get(resource_name, id, opts=None, admin_state_up=None, all_tags=None, availability_zone_hints=None, description=None, dns_domain=None, external=None, mtu=None, name=None, port_security_enabled=None, qos_policy_id=None, region=None, segments=None, shared=None, tags=None, tenant_id=None, transparent_vlan=None, value_specs=None)¶ Get an existing Network resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
all_tags (pulumi.Input[list]) – The collection of tags assigned on the network, which have been explicitly and implicitly added.
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_domainof a network in conjunction with thedns_nameattribute 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-mtuextension is enabled. Available for the modification, when Neutronnet-mtu-writableextension 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
falsewill disable port security. Valid values aretrueandfalse.qos_policy_id (pulumi.Input[str]) – Reference to the associated QoS policy.
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
regionargument 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_vlanattribute of the existing network.value_specs (pulumi.Input[dict]) – Map of additional options.
The segments object supports the following:
network_type(pulumi.Input[str]) - The type of physical network.physicalNetwork(pulumi.Input[str]) - The physical network where this network is implemented.segmentation_id(pulumi.Input[float]) - An isolated segment on the physical network.
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, qos_policy_id=None, region=None, security_group_ids=None, tags=None, tenant_id=None, value_specs=None, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 port resource within OpenStack.
import pulumi import pulumi_openstack as openstack network1 = openstack.networking.Network("network1", admin_state_up="true") port1 = openstack.networking.Port("port1", admin_state_up="true", network_id=network1.id)
import pulumi import pulumi_openstack as openstack network1 = openstack.networking.Network("network1", admin_state_up="true") port1 = openstack.networking.Port("port1", admin_state_up="true", binding={ "hostId": "b080b9cf-46e0-4ce8-ad47-0fd4accc872b", "profile": """{ "local_link_information": [ { "switch_info": "info1", "port_id": "Ethernet3/4", "switch_id": "12:34:56:78:9A:BC" }, { "switch_info": "info2", "port_id": "Ethernet3/4", "switch_id": "12:34:56:78:9A:BD" } ], "vlan_type": "allowed" } """, "vnicType": "baremetal", }, device_id="cdf70fcf-c161-4f24-9c70-96b3f5a54b71", device_owner="baremetal:none", network_id=network1.id)
There are some notes to consider when connecting Instances to networks using Ports. Please see the
compute.Instancedocumentation 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
trueorfalseif provided). Changing this updates theadmin_state_upof 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 port. Changing this updates the
descriptionof 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]) – The additional MAC address.
name (pulumi.Input[str]) – Name of the DHCP option.
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.
trueis 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 tofalseand nosecurity_group_idsare 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 tofalsewill disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrueandfalse.qos_policy_id (pulumi.Input[str]) – Reference to the associated QoS policy.
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
regionargument 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.
The allowed_address_pairs object supports the following:
ip_address(pulumi.Input[str]) - The additional IP address.mac_address(pulumi.Input[str]) - The additional MAC address.
The binding object supports the following:
hostId(pulumi.Input[str]) - The ID of the host to allocate port on.profile(pulumi.Input[str]) - Custom data to be passed asbinding:profile. Data must be passed as JSON.vifDetails(pulumi.Input[dict]) - A map of JSON strings containing additional details for this specific binding.vifType(pulumi.Input[str]) - The VNIC type of the port binding.vnicType(pulumi.Input[str]) - VNIC type for the port. Can either bedirect,direct-physical,macvtap,normal,baremetalorvirtio-forwarder. Default value isnormal.
The extra_dhcp_options object supports the following:
ip_version(pulumi.Input[float]) - IP protocol version. Defaults to 4.name(pulumi.Input[str]) - Name of the DHCP option.value(pulumi.Input[str]) - Value of the DHCP option.
The fixed_ips object supports the following:
ip_address(pulumi.Input[str]) - The additional IP address.subnet_id(pulumi.Input[str]) - Subnet in which to allocate IP address for this port.
admin_state_up: pulumi.Output[bool] = None¶Administrative up/down status for the port (must be
trueorfalseif provided). Changing this updates theadmin_state_upof an existing port.
all_fixed_ips: pulumi.Output[list] = None¶The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
all_security_group_ids: pulumi.Output[list] = None¶The collection of Security Group IDs on the port which have been explicitly and implicitly added.
The collection of tags assigned on the port, which have been explicitly and implicitly added.
allowed_address_pairs: pulumi.Output[list] = None¶An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
ip_address(str) - The additional IP address.mac_address(str) - The additional MAC address.
binding: pulumi.Output[dict] = None¶The port binding allows to specify binding information for the port. The structure is described below.
hostId(str) - The ID of the host to allocate port on.profile(str) - Custom data to be passed asbinding:profile. Data must be passed as JSON.vifDetails(dict) - A map of JSON strings containing additional details for this specific binding.vifType(str) - The VNIC type of the port binding.vnicType(str) - VNIC type for the port. Can either bedirect,direct-physical,macvtap,normal,baremetalorvirtio-forwarder. Default value isnormal.
description: pulumi.Output[str] = None¶Human-readable description of the port. Changing this updates the
descriptionof an existing port.
device_id: pulumi.Output[str] = None¶The ID of the device attached to the port. Changing this creates a new port.
device_owner: pulumi.Output[str] = None¶The device owner of the port. Changing this creates a new port.
dns_assignments: pulumi.Output[list] = None¶The list of maps representing port DNS assignments.
dns_name: pulumi.Output[str] = None¶The port DNS name. Available, when Neutron DNS extension is enabled.
extra_dhcp_options: pulumi.Output[list] = None¶An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times.
ip_version(float) - IP protocol version. Defaults to 4.name(str) - Name of the DHCP option.value(str) - Value of the DHCP option.
fixed_ips: pulumi.Output[list] = None¶An array of desired IPs for this port. The structure is described below.
ip_address(str) - The additional IP address.subnet_id(str) - Subnet in which to allocate IP address for this port.
mac_address: pulumi.Output[str] = None¶The additional MAC address.
name: pulumi.Output[str] = None¶Name of the DHCP option.
network_id: pulumi.Output[str] = None¶The ID of the network to attach the port to. Changing this creates a new port.
no_fixed_ip: pulumi.Output[bool] = None¶Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port.
trueis the only valid value for this argument.
no_security_groups: pulumi.Output[bool] = None¶If set to
true, then no security groups are applied to the port. If set tofalseand nosecurity_group_idsare 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.Output[bool] = 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 tofalsewill disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrueandfalse.
qos_policy_id: pulumi.Output[str] = None¶Reference to the associated QoS policy.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 Networking client. A Networking client is needed to create a port. If omitted, the
regionargument of the provider is used. Changing this creates a new port.
security_group_ids: pulumi.Output[list] = 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).
A set of string tags for the port.
tenant_id: pulumi.Output[str] = 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: pulumi.Output[dict] = None¶Map of additional options.
- static
get(resource_name, id, opts=None, admin_state_up=None, all_fixed_ips=None, all_security_group_ids=None, all_tags=None, allowed_address_pairs=None, binding=None, description=None, device_id=None, device_owner=None, dns_assignments=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, qos_policy_id=None, region=None, security_group_ids=None, tags=None, tenant_id=None, value_specs=None)¶ Get an existing Port resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
admin_state_up (pulumi.Input[bool]) – Administrative up/down status for the port (must be
trueorfalseif provided). Changing this updates theadmin_state_upof an existing port.all_fixed_ips (pulumi.Input[list]) – The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
all_security_group_ids (pulumi.Input[list]) – The collection of Security Group IDs on the port which have been explicitly and implicitly added.
all_tags (pulumi.Input[list]) – The collection of tags assigned on the port, which have been explicitly and implicitly added.
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 port. Changing this updates the
descriptionof 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_assignments (pulumi.Input[list]) – The list of maps representing port DNS assignments.
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]) – The additional MAC address.
name (pulumi.Input[str]) – Name of the DHCP option.
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.
trueis 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 tofalseand nosecurity_group_idsare 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 tofalsewill disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrueandfalse.qos_policy_id (pulumi.Input[str]) – Reference to the associated QoS policy.
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
regionargument 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.
The allowed_address_pairs object supports the following:
ip_address(pulumi.Input[str]) - The additional IP address.mac_address(pulumi.Input[str]) - The additional MAC address.
The binding object supports the following:
hostId(pulumi.Input[str]) - The ID of the host to allocate port on.profile(pulumi.Input[str]) - Custom data to be passed asbinding:profile. Data must be passed as JSON.vifDetails(pulumi.Input[dict]) - A map of JSON strings containing additional details for this specific binding.vifType(pulumi.Input[str]) - The VNIC type of the port binding.vnicType(pulumi.Input[str]) - VNIC type for the port. Can either bedirect,direct-physical,macvtap,normal,baremetalorvirtio-forwarder. Default value isnormal.
The extra_dhcp_options object supports the following:
ip_version(pulumi.Input[float]) - IP protocol version. Defaults to 4.name(pulumi.Input[str]) - Name of the DHCP option.value(pulumi.Input[str]) - Value of the DHCP option.
The fixed_ips object supports the following:
ip_address(pulumi.Input[str]) - The additional IP address.subnet_id(pulumi.Input[str]) - Subnet in which to allocate IP address for this port.
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, __props__=None, __name__=None, __opts__=None)¶ Create a PortSecGroupAssociate resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] enforce: Whether to replace or append the list of security
groups, specified in the
security_group_ids. Defaults tofalse.- Parameters
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
regionargument 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: pulumi.Output[list] = None¶The collection of Security Group IDs on the port which have been explicitly and implicitly added.
enforce: pulumi.Output[bool] = None¶Whether to replace or append the list of security groups, specified in the
security_group_ids. Defaults tofalse.
port_id: pulumi.Output[str] = None¶An UUID of the port to apply security groups to.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 networking client. A networking client is needed to manage a port. If omitted, the
regionargument of the provider is used. Changing this creates a new resource.
security_group_ids: pulumi.Output[list] = 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).
- static
get(resource_name, id, opts=None, all_security_group_ids=None, enforce=None, port_id=None, region=None, security_group_ids=None)¶ Get an existing PortSecGroupAssociate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
all_security_group_ids (pulumi.Input[list]) – The collection of Security Group IDs on the port which have been explicitly and implicitly added.
enforce (pulumi.Input[bool]) – Whether to replace or append the list of security groups, specified in the
security_group_ids. Defaults tofalse.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
regionargument 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).
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.QosBandwidthLimitRule(resource_name, opts=None, direction=None, max_burst_kbps=None, max_kbps=None, qos_policy_id=None, region=None, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 Neutron QoS bandwidth limit rule resource within OpenStack.
import pulumi import pulumi_openstack as openstack qos_policy1 = openstack.networking.QosPolicy("qosPolicy1", description="bw_limit") bw_limit_rule1 = openstack.networking.QosBandwidthLimitRule("bwLimitRule1", direction="egress", max_burst_kbps=300, max_kbps=3000, qos_policy_id=qos_policy1.id)
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
direction (pulumi.Input[str]) – The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS bandwidth limit rule.
max_burst_kbps (pulumi.Input[float]) – 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.
max_kbps (pulumi.Input[float]) – 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.
qos_policy_id (pulumi.Input[str]) – The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
region (pulumi.Input[str]) – 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
regionargument of the provider is used. Changing this creates a new QoS bandwidth limit rule.
direction: pulumi.Output[str] = None¶The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS bandwidth limit rule.
max_burst_kbps: pulumi.Output[float] = None¶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.
max_kbps: pulumi.Output[float] = None¶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.
qos_policy_id: pulumi.Output[str] = None¶The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
region: pulumi.Output[str] = None¶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
regionargument of the provider is used. Changing this creates a new QoS bandwidth limit rule.
- static
get(resource_name, id, opts=None, direction=None, max_burst_kbps=None, max_kbps=None, qos_policy_id=None, region=None)¶ Get an existing QosBandwidthLimitRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
direction (pulumi.Input[str]) – The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS bandwidth limit rule.
max_burst_kbps (pulumi.Input[float]) – 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.
max_kbps (pulumi.Input[float]) – 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.
qos_policy_id (pulumi.Input[str]) – The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
region (pulumi.Input[str]) – 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
regionargument of the provider is used. Changing this creates a new QoS bandwidth limit 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.QosDscpMarkingRule(resource_name, opts=None, dscp_mark=None, qos_policy_id=None, region=None, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 Neutron QoS DSCP marking rule resource within OpenStack.
import pulumi import pulumi_openstack as openstack qos_policy1 = openstack.networking.QosPolicy("qosPolicy1", description="dscp_mark") dscp_marking_rule1 = openstack.networking.QosDscpMarkingRule("dscpMarkingRule1", dscp_mark=26, qos_policy_id=qos_policy1.id)
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
dscp_mark (pulumi.Input[float]) – The value of DSCP mark. Changing this updates the DSCP mark value existing QoS DSCP marking rule.
qos_policy_id (pulumi.Input[str]) – The QoS policy reference. Changing this creates a new QoS DSCP marking rule.
region (pulumi.Input[str]) – 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
regionargument of the provider is used. Changing this creates a new QoS DSCP marking rule.
dscp_mark: pulumi.Output[float] = None¶The value of DSCP mark. Changing this updates the DSCP mark value existing QoS DSCP marking rule.
qos_policy_id: pulumi.Output[str] = None¶The QoS policy reference. Changing this creates a new QoS DSCP marking rule.
region: pulumi.Output[str] = None¶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
regionargument of the provider is used. Changing this creates a new QoS DSCP marking rule.
- static
get(resource_name, id, opts=None, dscp_mark=None, qos_policy_id=None, region=None)¶ Get an existing QosDscpMarkingRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
dscp_mark (pulumi.Input[float]) – The value of DSCP mark. Changing this updates the DSCP mark value existing QoS DSCP marking rule.
qos_policy_id (pulumi.Input[str]) – The QoS policy reference. Changing this creates a new QoS DSCP marking rule.
region (pulumi.Input[str]) – 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
regionargument of the provider is used. Changing this creates a new QoS DSCP marking 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.QosMinimumBandwidthRule(resource_name, opts=None, direction=None, min_kbps=None, qos_policy_id=None, region=None, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 Neutron QoS minimum bandwidth rule resource within OpenStack.
import pulumi import pulumi_openstack as openstack qos_policy1 = openstack.networking.QosPolicy("qosPolicy1", description="min_kbps") minimum_bandwidth_rule1 = openstack.networking.QosMinimumBandwidthRule("minimumBandwidthRule1", min_kbps=200, qos_policy_id=qos_policy1.id)
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
direction (pulumi.Input[str]) – The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS minimum bandwidth rule.
min_kbps (pulumi.Input[float]) – The minimum kilobits per second. Changing this updates the min kbps value of the existing QoS minimum bandwidth rule.
qos_policy_id (pulumi.Input[str]) – The QoS policy reference. Changing this creates a new QoS minimum bandwidth rule.
region (pulumi.Input[str]) – 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
regionargument of the provider is used. Changing this creates a new QoS minimum bandwidth rule.
direction: pulumi.Output[str] = None¶The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS minimum bandwidth rule.
min_kbps: pulumi.Output[float] = None¶The minimum kilobits per second. Changing this updates the min kbps value of the existing QoS minimum bandwidth rule.
qos_policy_id: pulumi.Output[str] = None¶The QoS policy reference. Changing this creates a new QoS minimum bandwidth rule.
region: pulumi.Output[str] = None¶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
regionargument of the provider is used. Changing this creates a new QoS minimum bandwidth rule.
- static
get(resource_name, id, opts=None, direction=None, min_kbps=None, qos_policy_id=None, region=None)¶ Get an existing QosMinimumBandwidthRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
direction (pulumi.Input[str]) – The direction of traffic. Defaults to “egress”. Changing this updates the direction of the existing QoS minimum bandwidth rule.
min_kbps (pulumi.Input[float]) – The minimum kilobits per second. Changing this updates the min kbps value of the existing QoS minimum bandwidth rule.
qos_policy_id (pulumi.Input[str]) – The QoS policy reference. Changing this creates a new QoS minimum bandwidth rule.
region (pulumi.Input[str]) – 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
regionargument of the provider is used. Changing this creates a new QoS minimum bandwidth 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.QosPolicy(resource_name, opts=None, description=None, is_default=None, name=None, project_id=None, region=None, shared=None, tags=None, value_specs=None, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 Neutron QoS policy resource within OpenStack.
import pulumi import pulumi_openstack as openstack qos_policy1 = openstack.networking.QosPolicy("qosPolicy1", description="bw_limit")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
is_default (pulumi.Input[bool]) – Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name (pulumi.Input[str]) – The name of the QoS policy. Changing this updates the name of the existing QoS policy.
project_id (pulumi.Input[str]) – The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the
regionargument of the provider is used. Changing this creates a new QoS policy.shared (pulumi.Input[bool]) – Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags (pulumi.Input[list]) – A set of string tags for the QoS policy.
value_specs (pulumi.Input[dict]) – Map of additional options.
The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
created_at: pulumi.Output[str] = None¶The time at which QoS policy was created.
description: pulumi.Output[str] = None¶The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
is_default: pulumi.Output[bool] = None¶Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name: pulumi.Output[str] = None¶The name of the QoS policy. Changing this updates the name of the existing QoS policy.
project_id: pulumi.Output[str] = None¶The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the
regionargument of the provider is used. Changing this creates a new QoS policy.
revision_number: pulumi.Output[float] = None¶The revision number of the QoS policy.
Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
A set of string tags for the QoS policy.
updated_at: pulumi.Output[str] = None¶The time at which QoS policy was created.
value_specs: pulumi.Output[dict] = None¶Map of additional options.
- static
get(resource_name, id, opts=None, all_tags=None, created_at=None, description=None, is_default=None, name=None, project_id=None, region=None, revision_number=None, shared=None, tags=None, updated_at=None, value_specs=None)¶ Get an existing QosPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
all_tags (pulumi.Input[list]) – The collection of tags assigned on the QoS policy, which have been explicitly and implicitly added.
created_at (pulumi.Input[str]) – The time at which QoS policy was created.
description (pulumi.Input[str]) – The human-readable description for the QoS policy. Changing this updates the description of the existing QoS policy.
is_default (pulumi.Input[bool]) – Indicates whether the QoS policy is default QoS policy or not. Changing this updates the default status of the existing QoS policy.
name (pulumi.Input[str]) – The name of the QoS policy. Changing this updates the name of the existing QoS policy.
project_id (pulumi.Input[str]) – The owner of the QoS policy. Required if admin wants to create a QoS policy for another project. Changing this creates a new QoS policy.
region (pulumi.Input[str]) – The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron Qos policy. If omitted, the
regionargument of the provider is used. Changing this creates a new QoS policy.revision_number (pulumi.Input[float]) – The revision number of the QoS policy.
shared (pulumi.Input[bool]) – Indicates whether this QoS policy is shared across all projects. Changing this updates the shared status of the existing QoS policy.
tags (pulumi.Input[list]) – A set of string tags for the QoS policy.
updated_at (pulumi.Input[str]) – The time at which QoS policy was created.
value_specs (pulumi.Input[dict]) – 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.QuotaV2(resource_name, opts=None, floatingip=None, network=None, port=None, project_id=None, rbac_policy=None, region=None, router=None, security_group=None, security_group_rule=None, subnet=None, subnetpool=None, __props__=None, __name__=None, __opts__=None)¶ 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.
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
floatingip (pulumi.Input[float]) – Quota value for floating IPs. Changing this updates the existing quota.
network (pulumi.Input[float]) – Quota value for networks. Changing this updates the existing quota.
port (pulumi.Input[float]) – Quota value for ports. Changing this updates the existing quota.
project_id (pulumi.Input[str]) – ID of the project to manage quota. Changing this creates new quota.
rbac_policy (pulumi.Input[float]) – Quota value for RBAC policies. Changing this updates the existing quota.
region (pulumi.Input[str]) – The region in which to create the quota. If omitted, the
regionargument of the provider is used. Changing this creates new quota.router (pulumi.Input[float]) – Quota value for routers. Changing this updates the existing quota.
security_group (pulumi.Input[float]) – Quota value for security groups. Changing this updates the existing quota.
security_group_rule (pulumi.Input[float]) – Quota value for security group rules. Changing this updates the existing quota.
subnet (pulumi.Input[float]) – Quota value for subnets. Changing this updates the existing quota.
subnetpool (pulumi.Input[float]) – Quota value for subnetpools. Changing this updates the existing quota.
floatingip: pulumi.Output[float] = None¶Quota value for floating IPs. Changing this updates the existing quota.
network: pulumi.Output[float] = None¶Quota value for networks. Changing this updates the existing quota.
port: pulumi.Output[float] = None¶Quota value for ports. Changing this updates the existing quota.
project_id: pulumi.Output[str] = None¶ID of the project to manage quota. Changing this creates new quota.
rbac_policy: pulumi.Output[float] = None¶Quota value for RBAC policies. Changing this updates the existing quota.
region: pulumi.Output[str] = None¶The region in which to create the quota. If omitted, the
regionargument of the provider is used. Changing this creates new quota.
router: pulumi.Output[float] = None¶Quota value for routers. Changing this updates the existing quota.
security_group: pulumi.Output[float] = None¶Quota value for security groups. Changing this updates the existing quota.
security_group_rule: pulumi.Output[float] = None¶Quota value for security group rules. Changing this updates the existing quota.
subnet: pulumi.Output[float] = None¶Quota value for subnets. Changing this updates the existing quota.
subnetpool: pulumi.Output[float] = None¶Quota value for subnetpools. Changing this updates the existing quota.
- static
get(resource_name, id, opts=None, floatingip=None, network=None, port=None, project_id=None, rbac_policy=None, region=None, router=None, security_group=None, security_group_rule=None, subnet=None, subnetpool=None)¶ Get an existing QuotaV2 resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
floatingip (pulumi.Input[float]) – Quota value for floating IPs. Changing this updates the existing quota.
network (pulumi.Input[float]) – Quota value for networks. Changing this updates the existing quota.
port (pulumi.Input[float]) – Quota value for ports. Changing this updates the existing quota.
project_id (pulumi.Input[str]) – ID of the project to manage quota. Changing this creates new quota.
rbac_policy (pulumi.Input[float]) – Quota value for RBAC policies. Changing this updates the existing quota.
region (pulumi.Input[str]) – The region in which to create the quota. If omitted, the
regionargument of the provider is used. Changing this creates new quota.router (pulumi.Input[float]) – Quota value for routers. Changing this updates the existing quota.
security_group (pulumi.Input[float]) – Quota value for security groups. Changing this updates the existing quota.
security_group_rule (pulumi.Input[float]) – Quota value for security group rules. Changing this updates the existing quota.
subnet (pulumi.Input[float]) – Quota value for subnets. Changing this updates the existing quota.
subnetpool (pulumi.Input[float]) – Quota value for subnetpools. Changing this updates the existing quota.
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.RbacPolicyV2(resource_name, opts=None, action=None, object_id=None, object_type=None, region=None, target_tenant=None, __props__=None, __name__=None, __opts__=None)¶ 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
access_as_sharedaction on that object.To make a network available as an external network for specific projects rather than all projects, use the
access_as_externalaction. 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.import pulumi import pulumi_openstack as openstack network1 = openstack.networking.Network("network1", admin_state_up="true") rbac_policy1 = openstack.networking.RbacPolicyV2("rbacPolicy1", action="access_as_shared", object_id=network1.id, object_type="network", target_tenant="20415a973c9e45d3917f078950644697")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
action (pulumi.Input[str]) – Action for the RBAC policy. Can either be
access_as_externaloraccess_as_shared.object_id (pulumi.Input[str]) – The ID of the
object_typeresource. Anobject_typeofnetworkreturns a network ID and anobject_typeofqos_policyreturns a QoS ID.object_type (pulumi.Input[str]) – The type of the object that the RBAC policy affects. Can either be
qos-policyornetwork.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
regionargument of the provider is used. Changing this creates a new routing entry.target_tenant (pulumi.Input[str]) – The ID of the tenant to which the RBAC policy will be enforced.
action: pulumi.Output[str] = None¶Action for the RBAC policy. Can either be
access_as_externaloraccess_as_shared.
object_id: pulumi.Output[str] = None¶The ID of the
object_typeresource. Anobject_typeofnetworkreturns a network ID and anobject_typeofqos_policyreturns a QoS ID.
object_type: pulumi.Output[str] = None¶The type of the object that the RBAC policy affects. Can either be
qos-policyornetwork.
region: pulumi.Output[str] = 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
regionargument of the provider is used. Changing this creates a new routing entry.
target_tenant: pulumi.Output[str] = None¶The ID of the tenant to which the RBAC policy will be enforced.
- static
get(resource_name, id, opts=None, action=None, object_id=None, object_type=None, project_id=None, region=None, target_tenant=None)¶ Get an existing RbacPolicyV2 resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
action (pulumi.Input[str]) – Action for the RBAC policy. Can either be
access_as_externaloraccess_as_shared.object_id (pulumi.Input[str]) – The ID of the
object_typeresource. Anobject_typeofnetworkreturns a network ID and anobject_typeofqos_policyreturns a QoS ID.object_type (pulumi.Input[str]) – The type of the object that the RBAC policy affects. Can either be
qos-policyornetwork.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
regionargument of the provider is used. Changing this creates a new routing entry.target_tenant (pulumi.Input[str]) – The ID of the tenant to which the RBAC policy will be enforced.
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, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 router resource within OpenStack.
import pulumi import pulumi_openstack as openstack router1 = openstack.networking.Router("router1", admin_state_up=True, external_network_id="f67f0d72-0ddf-11e4-9d95-e1f29f417e2f")
- 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_upof 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_idhas to be set in order to set this property. Changing this updates theenable_snatof the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.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_idhas 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
nameof 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
regionargument 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.
The external_fixed_ips object supports the following:
ip_address(pulumi.Input[str]) - The IP address to set on the router.subnet_id(pulumi.Input[str]) - Subnet in which the fixed IP belongs to.
The vendor_options object supports the following:
setRouterGatewayAfterCreate(pulumi.Input[bool]) - Boolean to control whether the Router gateway is assigned during creation or updated after creation.
admin_state_up: pulumi.Output[bool] = None¶Administrative up/down status for the router (must be “true” or “false” if provided). Changing this updates the
admin_state_upof an existing router.
The collection of tags assigned on the router, which have been explicitly and implicitly added.
availability_zone_hints: pulumi.Output[list] = 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: pulumi.Output[str] = None¶Human-readable description for the router.
distributed: pulumi.Output[bool] = 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: pulumi.Output[bool] = None¶Enable Source NAT for the router. Valid values are “true” or “false”. An
external_network_idhas to be set in order to set this property. Changing this updates theenable_snatof the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
external_fixed_ips: pulumi.Output[list] = None¶An external fixed IP for the router. This can be repeated. The structure is described below. An
external_network_idhas to be set in order to set this property. Changing this updates the external fixed IPs of the router.ip_address(str) - The IP address to set on the router.subnet_id(str) - Subnet in which the fixed IP belongs to.
external_gateway: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶A unique name for the router. Changing this updates the
nameof an existing router.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the
regionargument of the provider is used. Changing this creates a new router.
A set of string tags for the router.
tenant_id: pulumi.Output[str] = 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: pulumi.Output[dict] = None¶Map of additional driver-specific options.
vendor_options: pulumi.Output[dict] = None¶Map of additional vendor-specific options. Supported options are described below.
setRouterGatewayAfterCreate(bool) - Boolean to control whether the Router gateway is assigned during creation or updated after creation.
- static
get(resource_name, id, opts=None, admin_state_up=None, all_tags=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)¶ Get an existing Router resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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_upof an existing router.all_tags (pulumi.Input[list]) – The collection of tags assigned on the router, which have been explicitly and implicitly added.
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_idhas to be set in order to set this property. Changing this updates theenable_snatof the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.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_idhas 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
nameof 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
regionargument 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.
The external_fixed_ips object supports the following:
ip_address(pulumi.Input[str]) - The IP address to set on the router.subnet_id(pulumi.Input[str]) - Subnet in which the fixed IP belongs to.
The vendor_options object supports the following:
setRouterGatewayAfterCreate(pulumi.Input[bool]) - Boolean to control whether the Router gateway is assigned during creation or updated after creation.
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, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 router interface resource within OpenStack.
import pulumi import pulumi_openstack as openstack network1 = openstack.networking.Network("network1", admin_state_up="true") subnet1 = openstack.networking.Subnet("subnet1", cidr="192.168.199.0/24", ip_version=4, network_id=network1.id) router1 = openstack.networking.Router("router1", external_network_id="f67f0d72-0ddf-11e4-9d95-e1f29f417e2f") router_interface1 = openstack.networking.RouterInterface("routerInterface1", router_id=router1.id, subnet_id=subnet1.id)
- 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
regionargument 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: pulumi.Output[str] = None¶ID of the port this interface connects to. Changing this creates a new router interface.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the
regionargument of the provider is used. Changing this creates a new router interface.
router_id: pulumi.Output[str] = None¶ID of the router this interface belongs to. Changing this creates a new router interface.
subnet_id: pulumi.Output[str] = None¶ID of the subnet this interface connects to. Changing this creates a new router interface.
- static
get(resource_name, id, opts=None, port_id=None, region=None, router_id=None, subnet_id=None)¶ Get an existing RouterInterface resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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
regionargument 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.
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, __props__=None, __name__=None, __opts__=None)¶ Creates a routing entry on a OpenStack V2 router.
import pulumi import pulumi_openstack as openstack router1 = openstack.networking.Router("router1", admin_state_up="true") network1 = openstack.networking.Network("network1", admin_state_up="true") subnet1 = openstack.networking.Subnet("subnet1", cidr="192.168.199.0/24", ip_version=4, network_id=network1.id) int1 = openstack.networking.RouterInterface("int1", router_id=router1.id, subnet_id=subnet1.id) router_route1 = openstack.networking.RouterRoute("routerRoute1", destination_cidr="10.0.1.0/24", next_hop="192.168.199.254", router_id=router1.id)
The
next_hopIP address must be directly reachable from the router at thenetworking.RouterRouteresource creation time. You can ensure that by explicitly specifying a dependency on thenetworking.RouterInterfaceresource 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
regionargument 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: pulumi.Output[str] = None¶CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
next_hop: pulumi.Output[str] = None¶IP address of the next hop gateway. Changing this creates a new routing entry.
region: pulumi.Output[str] = 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
regionargument of the provider is used. Changing this creates a new routing entry.
router_id: pulumi.Output[str] = None¶ID of the router this routing entry belongs to. Changing this creates a new routing entry.
- static
get(resource_name, id, opts=None, destination_cidr=None, next_hop=None, region=None, router_id=None)¶ Get an existing RouterRoute resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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
regionargument 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.
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, __props__=None, __name__=None, __opts__=None)¶ Create a SecGroup resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] delete_default_rules: Whether or not to delete the default
egress security rules. This is
falseby default. See the below note for more information.- Parameters
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
regionargument 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.
The collection of tags assigned on the security group, which have been explicitly and implicitly added.
delete_default_rules: pulumi.Output[bool] = None¶Whether or not to delete the default egress security rules. This is
falseby default. See the below note for more information.
description: pulumi.Output[str] = None¶A unique name for the security group.
name: pulumi.Output[str] = None¶A unique name for the security group.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the
regionargument of the provider is used. Changing this creates a new security group.
A set of string tags for the security group.
tenant_id: pulumi.Output[str] = 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.
- static
get(resource_name, id, opts=None, all_tags=None, delete_default_rules=None, description=None, name=None, region=None, tags=None, tenant_id=None)¶ Get an existing SecGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
all_tags (pulumi.Input[list]) – The collection of tags assigned on the security group, which have been explicitly and implicitly added.
delete_default_rules (pulumi.Input[bool]) – Whether or not to delete the default egress security rules. This is
falseby 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
regionargument 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.
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, __props__=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.
import pulumi import pulumi_openstack as openstack secgroup1 = openstack.networking.SecGroup("secgroup1", description="My neutron security group") secgroup_rule1 = openstack.networking.SecGroupRule("secgroupRule1", direction="ingress", ethertype="IPv4", port_range_max=22, port_range_min=22, protocol="tcp", remote_ip_prefix="0.0.0.0/0", security_group_id=secgroup1.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.
* __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__
- 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
regionargument 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: pulumi.Output[str] = None¶A description of the rule. Changing this creates a new security group rule.
direction: pulumi.Output[str] = None¶The direction of the rule, valid values are ingress or egress. Changing this creates a new security group rule.
ethertype: pulumi.Output[str] = None¶The layer 3 protocol type, valid values are IPv4 or IPv6. Changing this creates a new security group rule.
port_range_max: pulumi.Output[float] = 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: pulumi.Output[float] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶The region in which to obtain the V2 networking client. A networking client is needed to create a port. If omitted, the
regionargument of the provider is used. Changing this creates a new security group rule.
remote_group_id: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = 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.
- static
get(resource_name, id, 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)¶ Get an existing SecGroupRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
* __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__
- 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
regionargument 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.
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, allocation_pools_collection=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, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 Neutron subnet resource within OpenStack.
import pulumi import pulumi_openstack as openstack network1 = openstack.networking.Network("network1", admin_state_up="true") subnet1 = openstack.networking.Subnet("subnet1", cidr="192.168.199.0/24", network_id=network1.id)
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
allocation_pools (pulumi.Input[list]) – A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. Multiple
allocation_poolblocks 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. Theallocation_poolblock is documented below.allocation_pools_collection (pulumi.Input[list]) – A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. The
allocation_poolsblock is documented below.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_gatewaywill cause a default gateway of.1to be used. Changing this updates the gateway IP of the existing subnet.host_routes (pulumi.Input[list]) – (Deprecated - use
networking.SubnetRouteinstead) 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, orslaac.ipv6_ra_mode (pulumi.Input[str]) – The IPv6 Router Advertisement mode. Valid values are
dhcpv6-stateful,dhcpv6-stateless, orslaac.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
regionargument 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.
The allocation_pools object supports the following:
end(pulumi.Input[str]) - The ending address.start(pulumi.Input[str]) - The starting address.
The allocation_pools_collection object supports the following:
end(pulumi.Input[str]) - The ending address.start(pulumi.Input[str]) - The starting address.
The host_routes object supports the following:
destination_cidr(pulumi.Input[str]) - The destination CIDR.next_hop(pulumi.Input[str]) - The next hop in the route.
The collection of ags assigned on the subnet, which have been explicitly and implicitly added.
allocation_pools: pulumi.Output[list] = None¶A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. Multiple
allocation_poolblocks 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. Theallocation_poolblock is documented below.end(str) - The ending address.start(str) - The starting address.
allocation_pools_collection: pulumi.Output[list] = None¶A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. The
allocation_poolsblock is documented below.end(str) - The ending address.start(str) - The starting address.
cidr: pulumi.Output[str] = 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: pulumi.Output[str] = None¶Human-readable description of the subnet. Changing this updates the name of the existing subnet.
dns_nameservers: pulumi.Output[list] = 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: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶Default gateway used by devices in this subnet. Leaving this blank and not setting
no_gatewaywill cause a default gateway of.1to be used. Changing this updates the gateway IP of the existing subnet.
host_routes: pulumi.Output[list] = None¶(Deprecated - use
networking.SubnetRouteinstead) 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.destination_cidr(str) - The destination CIDR.next_hop(str) - The next hop in the route.
ip_version: pulumi.Output[float] = None¶IP version, either 4 (default) or 6. Changing this creates a new subnet.
ipv6_address_mode: pulumi.Output[str] = None¶The IPv6 address mode. Valid values are
dhcpv6-stateful,dhcpv6-stateless, orslaac.
ipv6_ra_mode: pulumi.Output[str] = None¶The IPv6 Router Advertisement mode. Valid values are
dhcpv6-stateful,dhcpv6-stateless, orslaac.
name: pulumi.Output[str] = None¶The name of the subnet. Changing this updates the name of the existing subnet.
network_id: pulumi.Output[str] = None¶The UUID of the parent network. Changing this creates a new subnet.
no_gateway: pulumi.Output[bool] = 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: pulumi.Output[float] = 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: pulumi.Output[str] = None¶The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnet. If omitted, the
regionargument of the provider is used. Changing this creates a new subnet.
subnetpool_id: pulumi.Output[str] = None¶The ID of the subnetpool associated with the subnet.
A set of string tags for the subnet.
tenant_id: pulumi.Output[str] = 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: pulumi.Output[dict] = None¶Map of additional options.
- static
get(resource_name, id, opts=None, all_tags=None, allocation_pools=None, allocation_pools_collection=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)¶ Get an existing Subnet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
all_tags (pulumi.Input[list]) – The collection of ags assigned on the subnet, which have been explicitly and implicitly added.
allocation_pools (pulumi.Input[list]) – A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. Multiple
allocation_poolblocks 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. Theallocation_poolblock is documented below.allocation_pools_collection (pulumi.Input[list]) – A block declaring the start and end range of the IP addresses available for use with DHCP in this subnet. The
allocation_poolsblock is documented below.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_gatewaywill cause a default gateway of.1to be used. Changing this updates the gateway IP of the existing subnet.host_routes (pulumi.Input[list]) – (Deprecated - use
networking.SubnetRouteinstead) 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, orslaac.ipv6_ra_mode (pulumi.Input[str]) – The IPv6 Router Advertisement mode. Valid values are
dhcpv6-stateful,dhcpv6-stateless, orslaac.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
regionargument 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.
The allocation_pools object supports the following:
end(pulumi.Input[str]) - The ending address.start(pulumi.Input[str]) - The starting address.
The allocation_pools_collection object supports the following:
end(pulumi.Input[str]) - The ending address.start(pulumi.Input[str]) - The starting address.
The host_routes object supports the following:
destination_cidr(pulumi.Input[str]) - The destination CIDR.next_hop(pulumi.Input[str]) - The next hop in the route.
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, __props__=None, __name__=None, __opts__=None)¶ Manages a V2 Neutron subnetpool resource within OpenStack.
import pulumi import pulumi_openstack as openstack subnetpool1 = openstack.networking.SubnetPool("subnetpool1", ip_version=6, prefixes=[ "fdf7:b13d:dead:beef::/64", "fd65:86cc:a334:39b7::/64", ])
import pulumi import pulumi_openstack as openstack network1 = openstack.networking.Network("network1", admin_state_up="true") subnetpool1 = openstack.networking.SubnetPool("subnetpool1", prefixes=["10.11.12.0/24"]) subnet1 = openstack.networking.Subnet("subnet1", cidr="10.11.12.0/25", network_id=network1.id, subnetpool_id=subnetpool1.id)
- 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
regionargument 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: pulumi.Output[str] = None¶The Neutron address scope to assign to the subnetpool. Changing this updates the address scope id of the existing subnetpool.
The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
created_at: pulumi.Output[str] = None¶The time at which subnetpool was created.
default_prefixlen: pulumi.Output[float] = 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: pulumi.Output[float] = 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: pulumi.Output[str] = None¶The human-readable description for the subnetpool. Changing this updates the description of the existing subnetpool.
ip_version: pulumi.Output[float] = None¶The IP protocol version.
is_default: pulumi.Output[bool] = None¶Indicates whether the subnetpool is default subnetpool or not. Changing this updates the default status of the existing subnetpool.
max_prefixlen: pulumi.Output[float] = 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: pulumi.Output[float] = 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: pulumi.Output[str] = None¶The name of the subnetpool. Changing this updates the name of the existing subnetpool.
prefixes: pulumi.Output[list] = 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: pulumi.Output[str] = None¶The owner of the subnetpool. Required if admin wants to create a subnetpool for another project. Changing this creates a new subnetpool.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron subnetpool. If omitted, the
regionargument of the provider is used. Changing this creates a new subnetpool.
revision_number: pulumi.Output[float] = None¶The revision number of the subnetpool.
Indicates whether this subnetpool is shared across all projects. Changing this updates the shared status of the existing subnetpool.
A set of string tags for the subnetpool.
updated_at: pulumi.Output[str] = None¶The time at which subnetpool was created.
value_specs: pulumi.Output[dict] = None¶Map of additional options.
- static
get(resource_name, id, opts=None, 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, value_specs=None)¶ Get an existing SubnetPool resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
all_tags (pulumi.Input[list]) – The collection of tags assigned on the subnetpool, which have been explicitly and implicitly added.
created_at (pulumi.Input[str]) – The time at which subnetpool was created.
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
regionargument of the provider is used. Changing this creates a new subnetpool.revision_number (pulumi.Input[float]) – The revision number of the 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.
updated_at (pulumi.Input[str]) – The time at which subnetpool was created.
value_specs (pulumi.Input[dict]) – 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, __props__=None, __name__=None, __opts__=None)¶ Creates a routing entry on a OpenStack V2 subnet.
import pulumi import pulumi_openstack as openstack router1 = openstack.networking.Router("router1", admin_state_up="true") network1 = openstack.networking.Network("network1", admin_state_up="true") subnet1 = openstack.networking.Subnet("subnet1", cidr="192.168.199.0/24", ip_version=4, network_id=network1.id) subnet_route1 = openstack.networking.SubnetRoute("subnetRoute1", destination_cidr="10.0.1.0/24", next_hop="192.168.199.254", subnet_id=subnet1.id)
- 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
regionargument 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: pulumi.Output[str] = None¶CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
next_hop: pulumi.Output[str] = None¶IP address of the next hop gateway. Changing this creates a new routing entry.
region: pulumi.Output[str] = 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
regionargument of the provider is used. Changing this creates a new routing entry.
subnet_id: pulumi.Output[str] = None¶ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.
- static
get(resource_name, id, opts=None, destination_cidr=None, next_hop=None, region=None, subnet_id=None)¶ Get an existing SubnetRoute resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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
regionargument 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.
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, __props__=None, __name__=None, __opts__=None)¶ Manages a networking V2 trunk resource within OpenStack.
import pulumi import pulumi_openstack as openstack network1 = openstack.networking.Network("network1", admin_state_up="true") subnet1 = openstack.networking.Subnet("subnet1", cidr="192.168.1.0/24", enable_dhcp=True, ip_version=4, network_id=network1.id, no_gateway=True) parent_port1 = openstack.networking.Port("parentPort1", admin_state_up="true", network_id=network1.id) subport1 = openstack.networking.Port("subport1", admin_state_up="true", network_id=network1.id) trunk1 = openstack.networking.Trunk("trunk1", admin_state_up="true", port_id=parent_port1.id, sub_ports=[{ "port_id": subport1.id, "segmentation_id": 1, "segmentationType": "vlan", }]) instance1 = openstack.compute.Instance("instance1", networks=[{ "port": trunk1.port_id, }], security_groups=["default"])
- 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_upof 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
nameof an existing trunk.port_id (pulumi.Input[str]) – The ID of the port to be made a subport of the 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
regionargument 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.
The sub_ports object supports the following:
port_id(pulumi.Input[str]) - The ID of the port to be made a subport of the trunk.segmentation_id(pulumi.Input[float]) - The numeric id of the subport segment.segmentationType(pulumi.Input[str]) - The segmentation technology to use, e.g., “vlan”.
admin_state_up: pulumi.Output[bool] = None¶Administrative up/down status for the trunk (must be “true” or “false” if provided). Changing this updates the
admin_state_upof an existing trunk.
The collection of tags assigned on the trunk, which have been explicitly and implicitly added.
description: pulumi.Output[str] = None¶Human-readable description of the trunk. Changing this updates the name of the existing trunk.
name: pulumi.Output[str] = None¶A unique name for the trunk. Changing this updates the
nameof an existing trunk.
port_id: pulumi.Output[str] = None¶The ID of the port to be made a subport of the trunk.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 networking client. A networking client is needed to create a trunk. If omitted, the
regionargument of the provider is used. Changing this creates a new trunk.
sub_ports: pulumi.Output[list] = None¶The set of ports that will be made subports of the trunk. The structure of each subport is described below.
port_id(str) - The ID of the port to be made a subport of the trunk.segmentation_id(float) - The numeric id of the subport segment.segmentationType(str) - The segmentation technology to use, e.g., “vlan”.
A set of string tags for the port.
tenant_id: pulumi.Output[str] = 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.
- static
get(resource_name, id, opts=None, admin_state_up=None, all_tags=None, description=None, name=None, port_id=None, region=None, sub_ports=None, tags=None, tenant_id=None)¶ Get an existing Trunk resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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_upof an existing trunk.all_tags (pulumi.Input[list]) – The collection of tags assigned on the trunk, which have been explicitly and implicitly added.
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
nameof an existing trunk.port_id (pulumi.Input[str]) – The ID of the port to be made a subport of the 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
regionargument 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.
The sub_ports object supports the following:
port_id(pulumi.Input[str]) - The ID of the port to be made a subport of the trunk.segmentation_id(pulumi.Input[float]) - The numeric id of the subport segment.segmentationType(pulumi.Input[str]) - The segmentation technology to use, e.g., “vlan”.
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_address_scope(ip_version=None, name=None, project_id=None, region=None, shared=None, opts=None)¶Use this data source to get the ID of an available OpenStack address-scope.
import pulumi import pulumi_openstack as openstack public_addressscope = openstack.networking.get_address_scope(ip_version=4, name="public_addressscope", shared=True)
- Parameters
ip_version (float) – IP version.
name (str) – Name of the address-scope.
project_id (str) – The owner of the address-scope.
region (str) – The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve address-scopes. If omitted, the
regionargument of the provider is used.shared (bool) – Indicates whether this address-scope is shared across all projects.
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.
import pulumi import pulumi_openstack as openstack floatingip1 = openstack.networking.get_floating_ip(address="192.168.0.4")
- Parameters
address (str) – The IP address of the floating IP.
description (str) – Human-readable description of the floating IP.
fixed_ip (str) – The specific IP address of the internal port which should be associated with the floating IP.
pool (str) – The name of the pool from which the floating IP belongs to.
port_id (str) – The ID of the port the floating IP is attached.
region (str) – The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve floating IP ids. If omitted, the
regionargument of the provider is used.status (str) – status of the floating IP (ACTIVE/DOWN).
tags (list) – The list of floating IP tags to filter.
tenant_id (str) – The owner of the 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.
import pulumi import pulumi_openstack as openstack network = openstack.networking.get_network(name="tf_test_network")
- Parameters
description (str) – Human-readable description of the network.
external (bool) – The external routing facility of the network.
matching_subnet_cidr (str) – The CIDR of a subnet within the network.
mtu (float) – The network MTU to filter. Available, when Neutron
net-mtuextension is enabled.name (str) – The name of the network.
network_id (str) – The ID of the network.
region (str) – The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve networks ids. If omitted, the
regionargument of the provider is used.status (str) – The status of the network.
tags (list) – The list of network tags to filter.
tenant_id (str) – The owner of the network.
transparent_vlan (bool) – The VLAN transparent attribute for the 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.
import pulumi import pulumi_openstack as openstack port1 = openstack.networking.get_port(name="port_1")
- Parameters
admin_state_up (bool) – The administrative state of the port.
description (str) – Human-readable description of the port.
device_id (str) – The ID of the device the port belongs to.
device_owner (str) – The device owner of the port.
dns_name (str) – The port DNS name to filter. Available, when Neutron DNS extension is enabled.
fixed_ip (str) – The port IP address filter.
mac_address (str) – The MAC address of the port.
name (str) – The name of the port.
network_id (str) – The ID of the network the port belongs to.
port_id (str) – The ID of the port.
project_id (str) – The owner of the port.
region (str) – The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve port ids. If omitted, the
regionargument of the provider is used.security_group_ids (list) – The list of port security group IDs to filter.
status (str) – The status of the port.
tags (list) – The list of port tags to filter.
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.
import pulumi import pulumi_openstack as openstack ports = openstack.networking.get_port_ids(name="port")
- Parameters
admin_state_up (bool) – The administrative state of the port.
description (str) – Human-readable description of the port.
device_id (str) – The ID of the device the port belongs to.
device_owner (str) – The device owner of the port.
fixed_ip (str) – The port IP address filter.
mac_address (str) – The MAC address of the port.
name (str) – The name of the port.
network_id (str) – The ID of the network the port belongs to.
project_id (str) – The owner of the port.
region (str) – The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve port ids. If omitted, the
regionargument of the provider is used.security_group_ids (list) – The list of port security group IDs to filter.
sort_direction (str) – Order the results in either
ascordesc. Defaults to none.sort_key (str) – Sort ports based on a certain key. Defaults to none.
status (str) – The status of the port.
tags (list) – The list of port tags to filter.
pulumi_openstack.networking.get_qos_bandwidth_limit_rule(max_burst_kbps=None, max_kbps=None, qos_policy_id=None, region=None, opts=None)¶Use this data source to get the ID of an available OpenStack QoS bandwidth limit rule.
- Parameters
max_burst_kbps (float) – The maximum burst size in kilobits of a QoS bandwidth limit rule.
max_kbps (float) – The maximum kilobits per second of a QoS bandwidth limit rule.
qos_policy_id (str) – The QoS policy reference.
region (str) – 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
regionargument of the provider is used.
pulumi_openstack.networking.get_qos_dscp_marking_rule(dscp_mark=None, qos_policy_id=None, region=None, opts=None)¶Use this data source to get the ID of an available OpenStack QoS DSCP marking rule.
- Parameters
dscp_mark (float) – The value of a DSCP mark.
qos_policy_id (str) – The QoS policy reference.
region (str) – 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
regionargument of the provider is used.
pulumi_openstack.networking.get_qos_minimum_bandwidth_rule(direction=None, min_kbps=None, qos_policy_id=None, region=None, opts=None)¶Use this data source to get the ID of an available OpenStack QoS minimum bandwidth rule.
- Parameters
min_kbps (float) – The value of a minimum kbps bandwidth.
qos_policy_id (str) – The QoS policy reference.
region (str) – 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
regionargument of the provider is used.
pulumi_openstack.networking.get_qos_policy(description=None, is_default=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 QoS policy.
import pulumi import pulumi_openstack as openstack qos_policy1 = openstack.networking.get_qos_policy(name="qos_policy_1")
- Parameters
description (str) – The human-readable description for the QoS policy.
is_default (bool) – Whether the QoS policy is default policy or not.
name (str) – The name of the QoS policy.
project_id (str) – The owner of the QoS policy.
region (str) – The region in which to obtain the V2 Networking client. A Networking client is needed to retrieve a QoS policy ID. If omitted, the
regionargument of the provider is used.shared (bool) – Whether this QoS policy is shared across all projects.
tags (list) – The list of QoS policy tags to filter.
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.
import pulumi import pulumi_openstack as openstack router = openstack.networking.get_router(name="router_1")
- Parameters
admin_state_up (bool) – Administrative up/down status for the router (must be “true” or “false” if provided).
description (str) – Human-readable description of the router.
distributed (bool) – Indicates whether or not to get a distributed router.
enable_snat (bool) – The value that points out if the Source NAT is enabled on the router.
name (str) – The name of the router.
region (str) – The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve router ids. If omitted, the
regionargument of the provider is used.router_id (str) – The UUID of the router resource.
status (str) – The status of the router (ACTIVE/DOWN).
tags (list) – The list of router tags to filter.
tenant_id (str) – The owner of the 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.
import pulumi import pulumi_openstack as openstack secgroup = openstack.networking.get_sec_group(name="tf_test_secgroup")
- Parameters
description (str) – Human-readable description the the subnet.
name (str) – The name of the security group.
region (str) – The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve security groups ids. If omitted, the
regionargument of the provider is used.secgroup_id (str) – The ID of the security group.
tags (list) – The list of security group tags to filter.
tenant_id (str) – The owner of the 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.
import pulumi import pulumi_openstack as openstack subnet1 = openstack.networking.get_subnet(name="subnet_1")
- Parameters
cidr (str) – The CIDR of the subnet.
description (str) – Human-readable description for the subnet.
dhcp_disabled (bool) – If the subnet has DHCP disabled.
dhcp_enabled (bool) – If the subnet has DHCP enabled.
gateway_ip (str) – The IP of the subnet’s gateway.
ip_version (float) – The IP version of the subnet (either 4 or 6).
ipv6_address_mode (str) – The IPv6 address mode. Valid values are
dhcpv6-stateful,dhcpv6-stateless, orslaac.ipv6_ra_mode (str) – The IPv6 Router Advertisement mode. Valid values are
dhcpv6-stateful,dhcpv6-stateless, orslaac.name (str) – The name of the subnet.
network_id (str) – The ID of the network the subnet belongs to.
region (str) – The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve subnet ids. If omitted, the
regionargument of the provider is used.subnet_id (str) – The ID of the subnet.
subnetpool_id (str) – The ID of the subnetpool associated with the subnet.
tags (list) – The list of subnet tags to filter.
tenant_id (str) – The owner of the 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.
import pulumi import pulumi_openstack as openstack subnetpool1 = openstack.networking.get_subnet_pool(name="subnetpool_1")
- Parameters
address_scope_id (str) – The Neutron address scope that subnetpools is assigned to.
default_prefixlen (float) – The size of the subnetpool default prefix length.
default_quota (float) – The per-project quota on the prefix space that can be allocated from the subnetpool for project subnets.
description (str) – The human-readable description for the subnetpool.
ip_version (float) – The IP protocol version.
is_default (bool) – Whether the subnetpool is default subnetpool or not.
max_prefixlen (float) – The size of the subnetpool max prefix length.
min_prefixlen (float) – The size of the subnetpool min prefix length.
name (str) – The name of the subnetpool.
project_id (str) – The owner of the subnetpool.
region (str) – The region in which to obtain the V2 Networking client. A Networking client is needed to retrieve a subnetpool id. If omitted, the
regionargument of the provider is used.shared (bool) – Whether this subnetpool is shared across all projects.
tags (list) – The list of subnetpool tags to filter.
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.
import pulumi import pulumi_openstack as openstack trunk1 = openstack.networking.get_trunk(name="trunk_1")
- Parameters
admin_state_up (bool) – The administrative state of the trunk.
description (str) – Human-readable description of the trunk.
name (str) – The name of the trunk.
port_id (str) – The ID of the trunk parent port.
project_id (str) – The owner of the trunk.
region (str) – The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve trunk ids. If omitted, the
regionargument of the provider is used.status (str) – The status of the trunk.
tags (list) – The list of trunk tags to filter.
trunk_id (str) – The ID of the trunk.