For details on how to use network, see Using OpenStack Network
The network high-level interface is available through the network
member of a Connection
object. The
network
member will only be added if the service is detected.
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)dhcp_agent_hosting_networks
(agent, **query)A generator of networks hosted by a DHCP agent.
agent – Either the agent id of an instance of
Agent
query – kwargs query: Optional query parameters to be sent to limit the resources being returned.
A generator of networks
add_dhcp_agent_to_network
(agent, network)Add a DHCP Agent to a network
agent – Either the agent id of an instance of
Agent
network – Network instance
remove_dhcp_agent_from_network
(agent, network)Remove a DHCP Agent from a network
agent – Either the agent id of an instance of
Agent
network – Network instance
create_network
(**attrs)Create a new network from attributes
delete_network
(network, ignore_missing=True, if_revision=None)Delete a network
network – The value can be either the ID of a network or a
Network
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the network does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent network.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
None
find_network
(name_or_id, ignore_missing=True, **args)Find a single network
name_or_id – The name or ID of a network.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Network
or None
get_network
(network)Get a single network
networks
(**query)Return a generator of networks
query (kwargs) –
Optional query parameters to be sent to limit the resources being returned. Available parameters include:
description
: The network description.
ipv4_address_scope_id
: The ID of the IPv4 address scope forthe network.
ipv6_address_scope_id
: The ID of the IPv6 address scope forthe network.
is_admin_state_up
: Network administrative state
is_port_security_enabled
: The port security status.
is_router_external
: Network is external or not.
is_shared
: Whether the network is shared across projects.
name
: The name of the network.
status
: Network status
project_id
: Owner tenant ID
provider_network_type
: Network physical mechanism
provider_physical_network
: Physical network
provider_segmentation_id
: VLAN ID for VLAN networks or TunnelID for GENEVE/GRE/VXLAN networks
A generator of network objects
update_network
(network, if_revision=None, **attrs)Update a network
network – Either the id of a network or an instance of type
Network
.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
attrs (dict) – The attributes to update on the network represented
by network
.
The updated network
find_network_ip_availability
(name_or_id, ignore_missing=True, **args)Find IP availability of a network
name_or_id – The name or ID of a network.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
NetworkIPAvailability
or None
get_network_ip_availability
(network)Get IP availability of a network
network – The value can be the ID of a network or a
Network
instance.
One
NetworkIPAvailability
ResourceNotFound
when no resource can be found.
network_ip_availabilities
(**query)Return a generator of network ip availabilities
query (kwargs) –
Optional query parameters to be sent to limit the resources being returned. Available parameters include:
ip_version
: IP version of the network
network_id
: ID of network to use when listening network IPavailability.
network_name
: The name of the network for the particularnetwork IP availability.
project_id
: Owner tenant ID
A generator of network ip availability objects
NetworkIPAvailability
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_port
(**attrs)Create a new port from attributes
create_ports
(data)Create ports from the list of attributes
delete_port
(port, ignore_missing=True, if_revision=None)Delete a port
port – The value can be either the ID of a port or a
Port
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the port does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent port.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
None
find_port
(name_or_id, ignore_missing=True, **args)Find a single port
name_or_id – The name or ID of a port.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Port
or None
get_port
(port)Get a single port
ports
(**query)Return a generator of ports
query (kwargs) –
Optional query parameters to be sent to limit the resources being returned. Available parameters include:
description
: The port description.
device_id
: Port device ID.
device_owner
: Port device owner (e.g. network:dhcp
).
ip_address
: IP addresses of an allowed address pair.
is_admin_state_up
: The administrative state of the port.
is_port_security_enabled
: The port security status.
mac_address
: Port MAC address.
name
: The port name.
network_id
: ID of network that owns the ports.
project_id
: The ID of the project who owns the network.
status
: The port status. Value is ACTIVE
or DOWN
.
subnet_id
: The ID of the subnet.
A generator of port objects
update_port
(port, if_revision=None, **attrs)Update a port
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_router
(**attrs)Create a new router from attributes
delete_router
(router, ignore_missing=True, if_revision=None)Delete a router
router – The value can be either the ID of a router or a
Router
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the router does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent router.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
None
find_router
(name_or_id, ignore_missing=True, **args)Find a single router
name_or_id – The name or ID of a router.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Router
or None
get_router
(router)Get a single router
routers
(**query)Return a generator of routers
query (dict) –
the resources being returned. Valid parameters are:
description
: The description of a router.
flavor_id
: The ID of the flavor.
is_admin_state_up
: Router administrative state is up or not
is_distributed
: The distributed state of a router
is_ha
: The highly-available state of a router
name
: Router name
project_id
: The ID of the project this router is associatedwith.
status
: The status of the router.
A generator of router objects
update_router
(router, if_revision=None, **attrs)Update a router
add_interface_to_router
(router, subnet_id=None, port_id=None)Add Interface to a router
router – Either the router ID or an instance of
Router
subnet_id – ID of the subnet
port_id – ID of the port
Router with updated interface
~openstack.network.v2.router.Router
remove_interface_from_router
(router, subnet_id=None, port_id=None)Remove Interface from a router
router – Either the router ID or an instance of
Router
subnet – ID of the subnet
port – ID of the port
Router with updated interface
~openstack.network.v2.router.Router
add_extra_routes_to_router
(router, body)Add extra routes to a router
router – Either the router ID or an instance of
Router
body – The request body as documented in the api-ref.
Router with updated extra routes
~openstack.network.v2.router.Router
remove_extra_routes_from_router
(router, body)Remove extra routes from a router
router – Either the router ID or an instance of
Router
body – The request body as documented in the api-ref.
Router with updated extra routes
~openstack.network.v2.router.Router
add_gateway_to_router
(router, **body)Add Gateway to a router
router – Either the router ID or an instance of
Router
body – Body with the gateway information
Router with updated interface
~openstack.network.v2.router.Router
remove_gateway_from_router
(router, **body)Remove Gateway from a router
router – Either the router ID or an instance of
Router
body – Body with the gateway information
Router with updated interface
~openstack.network.v2.router.Router
create_conntrack_helper
(router, **attrs)Create a new L3 conntrack helper from attributes
router – Either the router ID or an instance of
Router
attrs (dict) – Keyword arguments which will be used to create a
ConntrackHelper
,
comprised of the properties on the ConntrackHelper class.
The results of conntrack helper creation
~openstack.network.v2.l3_conntrack_helper.ConntrackHelper
conntrack_helpers
(router, **query)Return a generator of conntrack helpers
router – Either the router ID or an instance of
Router
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of conntrack helper objects
~openstack.network.v2.l3_conntrack_helper.ConntrackHelper
get_conntrack_helper
(conntrack_helper, router)Get a single L3 conntrack helper
conntrack_helper – The value can be the ID of a L3 conntrack
helper or a
ConntrackHelper
,
instance.
router – The value can be the ID of a Router or a
Router
instance.
One
ConntrackHelper
ResourceNotFound
when no resource can be found.
update_conntrack_helper
(conntrack_helper, router, **attrs)Update a L3 conntrack_helper
conntrack_helper – The value can be the ID of a L3 conntrack
helper or a
ConntrackHelper
,
instance.
router – The value can be the ID of a Router or a
Router
instance.
The attributes to update on the L3 conntrack helper
represented by value
.
The updated conntrack helper
~openstack.network.v2.l3_conntrack_helper.ConntrackHelper
delete_conntrack_helper
(conntrack_helper, router, ignore_missing=True)Delete a L3 conntrack_helper
conntrack_helper – The value can be the ID of a L3 conntrack
helper or a
ConntrackHelper
,
instance.
router – The value can be the ID of a Router or a
Router
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the floating ip does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent ip.
None
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_ip
(**attrs)Create a new floating ip from attributes
attrs (dict) – Keyword arguments which will be used to create
a FloatingIP
,
comprised of the properties on the FloatingIP class.
The results of floating ip creation
delete_ip
(floating_ip, ignore_missing=True, if_revision=None)Delete a floating ip
floating_ip – The value can be either the ID of a floating ip
or a FloatingIP
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the floating ip does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent ip.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
None
find_available_ip
()Find an available IP
One FloatingIP
or None
find_ip
(name_or_id, ignore_missing=True, **args)Find a single IP
name_or_id – The name or ID of an IP.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One FloatingIP
or None
get_ip
(floating_ip)Get a single floating ip
floating_ip – The value can be the ID of a floating ip or a
FloatingIP
instance.
One FloatingIP
ResourceNotFound
when no resource can be found.
ips
(**query)Return a generator of ips
query (dict) –
the resources being returned. Valid parameters are:
description
: The description of a floating IP.
fixed_ip_address
: The fixed IP address associated with afloating IP address.
floating_ip_address
: The IP address of a floating IP.
floating_network_id
: The ID of the network associated witha floating IP.
port_id
: The ID of the port to which a floating IP isassociated.
project_id
: The ID of the project a floating IP isassociated with.
router_id
: The ID of an associated router.
status
: The status of a floating IP, which can be ACTIVE
or DOWN
.
A generator of floating IP objects
update_ip
(floating_ip, if_revision=None, **attrs)Update a ip
floating_ip – Either the id of a ip or a
FloatingIP
instance.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
attrs (dict) – The attributes to update on the ip represented
by value
.
The updated ip
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_pool
(**attrs)Create a new pool from attributes
delete_pool
(pool, ignore_missing=True)Delete a pool
pool – The value can be either the ID of a pool or a
Pool
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the pool does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent pool.
None
find_pool
(name_or_id, ignore_missing=True, **args)Find a single pool
name_or_id – The name or ID of a pool.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Pool
or None
get_pool
(pool)Get a single pool
pools
(**query)Return a generator of pools
query (dict) –
the resources being returned. Valid parameters are:
description
: The description for the pool.
is_admin_state_up
: The administrative state of the pool.
lb_algorithm
: The load-balancer algorithm used, which is oneof round-robin
, least-connections
and so on.
name
: The name of the node pool.
project_id
: The ID of the project the pool is associatedwith.
protocol
: The protocol used by the pool, which is one ofTCP
, HTTP
or HTTPS
.
provider
: The name of the provider of the load balancerservice.
subnet_id
: The subnet on which the members of the pool arelocated.
virtual_ip_id
: The ID of the virtual IP used.
A generator of pool objects
update_pool
(pool, **attrs)Update a pool
create_pool_member
(pool, **attrs)Create a new pool member from attributes
pool – The pool can be either the ID of a pool or a
Pool
instance that
the member will be created in.
attrs (dict) – Keyword arguments which will be used to create
a PoolMember
,
comprised of the properties on the PoolMember class.
The results of pool member creation
delete_pool_member
(pool_member, pool, ignore_missing=True)Delete a pool member
pool_member – The member can be either the ID of a pool member or a
PoolMember
instance.
pool – The pool can be either the ID of a pool or a
Pool
instance that
the member belongs to.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the pool member does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent pool member.
None
find_pool_member
(name_or_id, pool, ignore_missing=True, **args)Find a single pool member
name_or_id (str) – The name or ID of a pool member.
pool – The pool can be either the ID of a pool or a
Pool
instance that
the member belongs to.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One PoolMember
or None
get_pool_member
(pool_member, pool)Get a single pool member
pool_member – The member can be the ID of a pool member or a
PoolMember
instance.
pool – The pool can be either the ID of a pool or a
Pool
instance that
the member belongs to.
One PoolMember
ResourceNotFound
when no resource can be found.
pool_members
(pool, **query)Return a generator of pool members
pool – The pool can be either the ID of a pool or a
Pool
instance that
the member belongs to.
query (dict) –
the resources being returned. Valid parameters are:
address
: The IP address of the pool member.
is_admin_state_up
: The administrative state of the poolmember.
name
: Name of the pool member.
project_id
: The ID of the project this pool member isassociated with.
protocol_port
: The port on which the application is hosted.
subnet_id
: Subnet ID in which to access this pool member.
weight
: A positive integer value that indicates the relativeportion of traffic that this member should receive from the pool.
A generator of pool member objects
update_pool_member
(pool_member, pool, **attrs)Update a pool member
pool_member – Either the ID of a pool member or a
PoolMember
instance.
pool – The pool can be either the ID of a pool or a
Pool
instance that
the member belongs to.
attrs (dict) – The attributes to update on the pool member
represented by pool_member
.
The updated pool member
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)get_auto_allocated_topology
(project=None)Get the auto-allocated topology of a given tenant
project – The value is the ID or name of a project
The auto-allocated topology
AutoAllocatedTopology
delete_auto_allocated_topology
(project=None, ignore_missing=False)Delete auto-allocated topology
project – The value is the ID or name of a project
ignore_missing – When set to False
ResourceNotFound
will be
raised when the topology does not exist.
When set to True
, no exception will be raised when
attempting to delete nonexistant topology
None
validate_auto_allocated_topology
(project=None)Validate the resources for auto allocation
project – The value is the ID or name of a project
Whether all resources are correctly configured or not
ValidateTopology
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_security_group
(**attrs)Create a new security group from attributes
attrs (dict) – Keyword arguments which will be used to create
a SecurityGroup
,
comprised of the properties on the SecurityGroup class.
The results of security group creation
delete_security_group
(security_group, ignore_missing=True, if_revision=None)Delete a security group
security_group – The value can be either the ID of a security group or a
SecurityGroup
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the security group does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent security group.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
None
find_security_group
(name_or_id, ignore_missing=True, **args)Find a single security group
name_or_id – The name or ID of a security group.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
SecurityGroup
or None
get_security_group
(security_group)Get a single security group
security_group – The value can be the ID of a security group or a
SecurityGroup
instance.
One
SecurityGroup
ResourceNotFound
when no resource can be found.
security_groups
(**query)Return a generator of security groups
query (dict) –
the resources being returned. Valid parameters are:
description
: Security group description
ìd
: The id of a security group, or list of security group ids
name
: The name of a security group
project_id
: The ID of the project this security group isassociated with.
A generator of security group objects
update_security_group
(security_group, if_revision=None, **attrs)Update a security group
security_group – Either the id of a security group or a
SecurityGroup
instance.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
attrs (dict) – The attributes to update on the security group
represented by security_group
.
The updated security group
create_security_group_rule
(**attrs)Create a new security group rule from attributes
attrs (dict) – Keyword arguments which will be used to create a
SecurityGroupRule
, comprised of the properties on the
SecurityGroupRule class.
The results of security group rule creation
SecurityGroupRule
create_security_group_rules
(data)Create new security group rules from the list of attributes
data (list) – List of dicts of attributes which will be used to
create a SecurityGroupRule
,
comprised of the properties on the SecurityGroupRule
class.
A generator of security group rule objects
SecurityGroupRule
delete_security_group_rule
(security_group_rule, ignore_missing=True, if_revision=None)Delete a security group rule
security_group_rule – The value can be either the ID of a security group rule
or a
SecurityGroupRule
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the security group rule does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent security group rule.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
None
find_security_group_rule
(name_or_id, ignore_missing=True, **args)Find a single security group rule
name_or_id (str) – The ID of a security group rule.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
SecurityGroupRule
or None
get_security_group_rule
(security_group_rule)Get a single security group rule
security_group_rule – The value can be the ID of a security group rule or a
SecurityGroupRule
instance.
SecurityGroupRule
ResourceNotFound
when no resource can be found.
security_group_rules
(**query)Return a generator of security group rules
query (kwargs) –
Optional query parameters to be sent to limit the resources being returned. Available parameters include:
description
: The security group rule description
direction
: Security group rule direction
ether_type
: Must be IPv4 or IPv6, and addresses representedin CIDR must match the ingress or egress rule.
project_id
: The ID of the project this security group ruleis associated with.
protocol
: Security group rule protocol
remote_group_id
: ID of a remote security group
security_group_id
: ID of security group that owns the rules
A generator of security group rule objects
SecurityGroupRule
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)availability_zones
(**query)Return a generator of availability zones
query (dict) –
returned resources. Valid parameters include:
name
: The name of an availability zone.
resource
: The type of resource for the availability zone.
A generator of availability zone objects
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_address_scope
(**attrs)Create a new address scope from attributes
attrs (dict) – Keyword arguments which will be used to create
a AddressScope
,
comprised of the properties on the AddressScope class.
The results of address scope creation
delete_address_scope
(address_scope, ignore_missing=True)Delete an address scope
address_scope – The value can be either the ID of an
address scope or
a AddressScope
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the address scope does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent address scope.
None
find_address_scope
(name_or_id, ignore_missing=True, **args)Find a single address scope
name_or_id – The name or ID of an address scope.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One AddressScope
or None
get_address_scope
(address_scope)Get a single address scope
address_scope – The value can be the ID of an address scope or a
AddressScope
instance.
One AddressScope
ResourceNotFound
when no resource can be found.
address_scopes
(**query)Return a generator of address scopes
query (dict) –
the resources being returned.
name
: Address scope name
ip_version
: Address scope IP address version
tenant_id
: Owner tenant ID
shared
: Address scope is shared (boolean)
A generator of address scope objects
update_address_scope
(address_scope, **attrs)Update an address scope
address_scope – Either the ID of an address scope or a
AddressScope
instance.
attrs (dict) – The attributes to update on the address scope
represented by value
.
The updated address scope
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)delete_quota
(quota, ignore_missing=True)Delete a quota (i.e. reset to the default quota)
quota – The value can be either the ID of a quota or a
Quota
instance.
The ID of a quota is the same as the project ID
for the quota.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when quota does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent quota.
None
get_quota
(quota, details=False)Get a quota
get_quota_default
(quota)Get a default quota
quota – The value can be the ID of a default quota or a
QuotaDefault
instance. The ID of a default quota is the same
as the project ID for the default quota.
One QuotaDefault
ResourceNotFound
when no resource can be found.
quotas
(**query)Return a generator of quotas
query (dict) – Optional query parameters to be sent to limit the resources being returned. Currently no query parameter is supported.
A generator of quota objects
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_qos_bandwidth_limit_rule
(qos_policy, **attrs)Create a new bandwidth limit rule
attrs (dict) – Keyword arguments which will be used to create
a QoSBandwidthLimitRule
,
comprised of the properties on the
QoSBandwidthLimitRule class.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
The results of resource creation
QoSBandwidthLimitRule
delete_qos_bandwidth_limit_rule
(qos_rule, qos_policy, ignore_missing=True)Delete a bandwidth limit rule
qos_rule – The value can be either the ID of a bandwidth limit
rule or a QoSBandwidthLimitRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent bandwidth limit rule.
None
find_qos_bandwidth_limit_rule
(qos_rule_id, qos_policy, ignore_missing=True, **args)Find a bandwidth limit rule
qos_rule_id – The ID of a bandwidth limit rule.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
QoSBandwidthLimitRule
or None
get_qos_bandwidth_limit_rule
(qos_rule, qos_policy)Get a single bandwidth limit rule
qos_rule – The value can be the ID of a minimum bandwidth rule or
a QoSBandwidthLimitRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
One
QoSBandwidthLimitRule
ResourceNotFound
when no resource can be found.
qos_bandwidth_limit_rules
(qos_policy, **query)Return a generator of bandwidth limit rules
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of bandwidth limit rule objects
QoSBandwidthLimitRule
update_qos_bandwidth_limit_rule
(qos_rule, qos_policy, **attrs)Update a bandwidth limit rule
qos_rule – Either the id of a bandwidth limit rule or a
QoSBandwidthLimitRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
The attributes to update on the bandwidth limit rule
represented by value
.
The updated minimum bandwidth rule
QoSBandwidthLimitRule
create_qos_dscp_marking_rule
(qos_policy, **attrs)Create a new QoS DSCP marking rule
attrs (dict) – Keyword arguments which will be used to create
a QoSDSCPMarkingRule
,
comprised of the properties on the
QosDscpMarkingRule class.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
The results of router creation
QoSDSCPMarkingRule
delete_qos_dscp_marking_rule
(qos_rule, qos_policy, ignore_missing=True)Delete a QoS DSCP marking rule
qos_rule – The value can be either the ID of a minimum bandwidth
rule or a QoSDSCPMarkingRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent minimum bandwidth rule.
None
find_qos_dscp_marking_rule
(qos_rule_id, qos_policy, ignore_missing=True, **args)Find a QoS DSCP marking rule
qos_rule_id – The ID of a QoS DSCP marking rule.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
QoSDSCPMarkingRule
or None
get_qos_dscp_marking_rule
(qos_rule, qos_policy)Get a single QoS DSCP marking rule
qos_rule – The value can be the ID of a minimum bandwidth rule or
a
QoSDSCPMarkingRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
One
QoSDSCPMarkingRule
ResourceNotFound
when no resource can be found.
qos_dscp_marking_rules
(qos_policy, **query)Return a generator of QoS DSCP marking rules
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of QoS DSCP marking rule objects
QoSDSCPMarkingRule
update_qos_dscp_marking_rule
(qos_rule, qos_policy, **attrs)Update a QoS DSCP marking rule
qos_rule – Either the id of a minimum bandwidth rule or a
QoSDSCPMarkingRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
The attributes to update on the QoS DSCP marking rule
represented by value
.
The updated QoS DSCP marking rule
QoSDSCPMarkingRule
create_qos_minimum_bandwidth_rule
(qos_policy, **attrs)Create a new minimum bandwidth rule
attrs (dict) – Keyword arguments which will be used to create
a QoSMinimumBandwidthRule
,
comprised of the properties on the
QoSMinimumBandwidthRule class.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
The results of resource creation
QoSMinimumBandwidthRule
delete_qos_minimum_bandwidth_rule
(qos_rule, qos_policy, ignore_missing=True)Delete a minimum bandwidth rule
qos_rule – The value can be either the ID of a minimum bandwidth
rule or a QoSMinimumBandwidthRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent minimum bandwidth rule.
None
find_qos_minimum_bandwidth_rule
(qos_rule_id, qos_policy, ignore_missing=True, **args)Find a minimum bandwidth rule
qos_rule_id – The ID of a minimum bandwidth rule.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
QoSMinimumBandwidthRule
or None
get_qos_minimum_bandwidth_rule
(qos_rule, qos_policy)Get a single minimum bandwidth rule
qos_rule – The value can be the ID of a minimum bandwidth rule or
a QoSMinimumBandwidthRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
One
QoSMinimumBandwidthRule
ResourceNotFound
when no resource can be found.
qos_minimum_bandwidth_rules
(qos_policy, **query)Return a generator of minimum bandwidth rules
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of minimum bandwidth rule objects
QoSMinimumBandwidthRule
update_qos_minimum_bandwidth_rule
(qos_rule, qos_policy, **attrs)Update a minimum bandwidth rule
qos_rule – Either the id of a minimum bandwidth rule or a
QoSMinimumBandwidthRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a QoSPolicy
instance.
The attributes to update on the minimum bandwidth rule
represented by value
.
The updated minimum bandwidth rule
QoSMinimumBandwidthRule
create_qos_policy
(**attrs)Create a new QoS policy from attributes
attrs (dict) – Keyword arguments which will be used to create
a
QoSPolicy
, comprised of the properties on the
QoSPolicy class.
The results of QoS policy creation
delete_qos_policy
(qos_policy, ignore_missing=True)Delete a QoS policy
qos_policy – The value can be either the ID of a QoS policy or a
QoSPolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the QoS policy does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent QoS policy.
None
find_qos_policy
(name_or_id, ignore_missing=True, **args)Find a single QoS policy
name_or_id – The name or ID of a QoS policy.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One QoSPolicy
or
None
get_qos_policy
(qos_policy)Get a single QoS policy
qos_policies
(**query)Return a generator of QoS policies
query (dict) –
the resources being returned. Valid parameters are:
description
: The description of a QoS policy.
is_shared
: Whether the policy is shared among projects.
name
: The name of a QoS policy.
project_id
: The ID of the project who owns the network.
A generator of QoS policy objects
update_qos_policy
(qos_policy, **attrs)Update a QoS policy
find_qos_rule_type
(rule_type_name, ignore_missing=True)Find a single QoS rule type details
rule_type_name – The name of a QoS rule type.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
One QoSRuleType
or None
get_qos_rule_type
(qos_rule_type)Get details about single QoS rule type
qos_rule_type – The value can be the name of a QoS policy
rule type or a
QoSRuleType
instance.
One QoSRuleType
ResourceNotFound
when no resource can be found.
qos_rule_types
(**query)Return a generator of QoS rule types
query (dict) –
resources returned. Valid parameters include:
type
: The type of the QoS rule type.
A generator of QoS rule type objects
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)agents
(**query)Return a generator of network agents
query (dict) –
resources being returned.
agent_type
: Agent type.
availability_zone
: The availability zone for an agent.
binary
: The name of the agent’s application binary.
description
: The description of the agent.
host
: The host (host name or host address) the agent isrunning on.
topic
: The message queue topic used.
is_admin_state_up
: The administrative state of the agent.
is_alive
: Whether the agent is alive.
A generator of agents
delete_agent
(agent, ignore_missing=True)Delete a network agent
agent – The value can be the ID of a agent or a
Agent
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the agent does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent agent.
None
get_agent
(agent)Get a single network agent
update_agent
(agent, **attrs)Update a network agent
network_hosting_dhcp_agents
(network, **query)A generator of DHCP agents hosted on a network.
network – The instance of
Network
query (dict) – Optional query parameters to be sent to limit the resources returned.
A generator of hosted DHCP agents
routers_hosting_l3_agents
(router, **query)Return a generator of L3 agent hosting a router
router – Either the router id or an instance of
Router
query (kwargs) – Optional query parameters to be sent to limit the resources returned
A generator of Router L3 Agents
RouterL3Agents
agent_hosted_routers
(agent, **query)Return a generator of routers hosted by a L3 agent
agent – Either the agent id of an instance of
Agent
query (kwargs) – Optional query parameters to be sent to limit the resources returned
A generator of routers
L3AgentRouters
add_router_to_agent
(agent, router)Add router to L3 agent
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_rbac_policy
(**attrs)Create a new RBAC policy from attributes
attrs (dict) – Keyword arguments which will be used to create a
RBACPolicy
,
comprised of the properties on the RBACPolicy class.
The results of RBAC policy creation
delete_rbac_policy
(rbac_policy, ignore_missing=True)Delete a RBAC policy
rbac_policy – The value can be either the ID of a RBAC policy or
a RBACPolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the RBAC policy does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent RBAC policy.
None
find_rbac_policy
(rbac_policy, ignore_missing=True, **args)Find a single RBAC policy
rbac_policy – The ID of a RBAC policy.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
RBACPolicy
or None
get_rbac_policy
(rbac_policy)Get a single RBAC policy
rbac_policy – The value can be the ID of a RBAC policy or a
RBACPolicy
instance.
One RBACPolicy
ResourceNotFound
when no resource can be found.
rbac_policies
(**query)Return a generator of RBAC policies
query (dict) –
the resources being returned. Available parameters include:
action
: RBAC policy action
object_type
: Type of the object that the RBAC policy affects
target_project_id
: ID of the tenant that the RBAC policyaffects
project_id
: Owner tenant ID
A generator of rbac objects
update_rbac_policy
(rbac_policy, **attrs)Update a RBAC policy
rbac_policy – Either the id of a RBAC policy or a
RBACPolicy
instance.
attrs (dict) – The attributes to update on the RBAC policy
represented by rbac_policy
.
The updated RBAC policy
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_listener
(**attrs)Create a new listener from attributes
delete_listener
(listener, ignore_missing=True)Delete a listener
listener – The value can be either the ID of a listner or a
Listener
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the listner does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent listener.
None
find_listener
(name_or_id, ignore_missing=True, **args)Find a single listener
name_or_id – The name or ID of a listener.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Listener
or None
get_listener
(listener)Get a single listener
listeners
(**query)Return a generator of listeners
query (dict) –
the resources being returned. Valid parameters are:
connection_limit
: The maximum number of connectionspermitted for the load-balancer.
default_pool_id
: The ID of the default pool.
default_tls_container_ref
: A reference to a container of TLSsecret.
description
: The description of a listener.
is_admin_state_up
: The administrative state of the listener.
name
: The name of a listener.
project_id
: The ID of the project associated with a listener.
protocol
: The protocol of the listener.
protocol_port
: Port the listener will listen to.
A generator of listener objects
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_subnet
(**attrs)Create a new subnet from attributes
delete_subnet
(subnet, ignore_missing=True, if_revision=None)Delete a subnet
subnet – The value can be either the ID of a subnet or a
Subnet
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the subnet does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent subnet.
if_revision (int) – Revision to put in If-Match header of update request to perform compare-and-swap update.
None
find_subnet
(name_or_id, ignore_missing=True, **args)Find a single subnet
name_or_id – The name or ID of a subnet.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Subnet
or None
get_subnet
(subnet)Get a single subnet
subnets
(**query)Return a generator of subnets
query (dict) –
Optional query parameters to be sent to limit the resources being returned. Available parameters include:
cidr
: Subnet CIDR
description
: The subnet description
gateway_ip
: Subnet gateway IP address
ip_version
: Subnet IP address version
ipv6_address_mode
: The IPv6 address mode
ipv6_ra_mode
: The IPv6 router advertisement mode
is_dhcp_enabled
: Subnet has DHCP enabled (boolean)
name
: Subnet name
network_id
: ID of network that owns the subnets
project_id
: Owner tenant ID
subnet_pool_id
: The subnet pool ID from which to obtain aCIDR.
A generator of subnet objects
update_subnet
(subnet, if_revision=None, **attrs)Update a subnet
create_subnet_pool
(**attrs)Create a new subnet pool from attributes
attrs (dict) – Keyword arguments which will be used to create
a SubnetPool
,
comprised of the properties on the SubnetPool class.
The results of subnet pool creation
delete_subnet_pool
(subnet_pool, ignore_missing=True)Delete a subnet pool
subnet_pool – The value can be either the ID of a subnet pool or
a SubnetPool
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the subnet pool does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent subnet pool.
None
find_subnet_pool
(name_or_id, ignore_missing=True, **args)Find a single subnet pool
name_or_id – The name or ID of a subnet pool.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One SubnetPool
or None
get_subnet_pool
(subnet_pool)Get a single subnet pool
subnet_pool – The value can be the ID of a subnet pool or a
SubnetPool
instance.
One SubnetPool
ResourceNotFound
when no resource can be found.
subnet_pools
(**query)Return a generator of subnet pools
query (kwargs) –
Optional query parameters to be sent to limit the resources being returned. Available parameters include:
address_scope_id
: Subnet pool address scope ID
description
: The subnet pool description
ip_version
: The IP address family
is_default
: Subnet pool is the default (boolean)
is_shared
: Subnet pool is shared (boolean)
name
: Subnet pool name
project_id
: Owner tenant ID
A generator of subnet pool objects
update_subnet_pool
(subnet_pool, **attrs)Update a subnet pool
subnet_pool – Either the ID of a subnet pool or a
SubnetPool
instance.
attrs (dict) – The attributes to update on the subnet pool
represented by subnet_pool
.
The updated subnet pool
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_load_balancer
(**attrs)Create a new load balancer from attributes
attrs (dict) – Keyword arguments which will be used to create
a LoadBalancer
,
comprised of the properties on the LoadBalancer class.
The results of load balancer creation
delete_load_balancer
(load_balancer, ignore_missing=True)Delete a load balancer
load_balancer – The value can be the ID of a load balancer or a
LoadBalancer
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the load balancer does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent load balancer.
None
find_load_balancer
(name_or_id, ignore_missing=True, **args)Find a single load balancer
name_or_id – The name or ID of a load balancer.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One LoadBalancer
or None
get_load_balancer
(load_balancer)Get a single load balancer
load_balancer – The value can be the ID of a load balancer or a
LoadBalancer
instance.
One LoadBalancer
ResourceNotFound
when no resource can be found.
load_balancers
(**query)Return a generator of load balancers
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of load balancer objects
update_load_balancer
(load_balancer, **attrs)Update a load balancer
load_balancer – Either the id of a load balancer or a
LoadBalancer
instance.
attrs (dict) – The attributes to update on the load balancer
represented by load_balancer
.
The updated load balancer
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_health_monitor
(**attrs)Create a new health monitor from attributes
attrs (dict) – Keyword arguments which will be used to create
a HealthMonitor
,
comprised of the properties on the HealthMonitor class.
The results of health monitor creation
delete_health_monitor
(health_monitor, ignore_missing=True)Delete a health monitor
health_monitor – The value can be either the ID of a
health monitor or a
HealthMonitor
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the health monitor does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent health monitor.
None
find_health_monitor
(name_or_id, ignore_missing=True, **args)Find a single health monitor
name_or_id – The name or ID of a health monitor.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
HealthMonitor
or None
get_health_monitor
(health_monitor)Get a single health monitor
health_monitor – The value can be the ID of a health monitor or a
HealthMonitor
instance.
One
HealthMonitor
ResourceNotFound
when no resource can be found.
health_monitors
(**query)Return a generator of health monitors
query (dict) –
the resources being returned. Valid parameters are:
delay
: the time in milliseconds between sending probes.
expected_codes
: The expected HTTP codes for a pssing HTTP(S)monitor.
http_method
: The HTTP method a monitor uses for requests.
is_admin_state_up
: The administrative state of a healthmonitor.
max_retries
: The maximum consecutive health probe attempts.
project_id
: The ID of the project this health monitor isassociated with.
timeout
: The maximum number of milliseconds for a monitor towait for a connection to be established before it times out.
type
: The type of probe sent by the load balancer for healthcheck, which can be PING
, TCP
, HTTP
or
HTTPS
.
url_path
: The path portion of a URI that will be probed.
A generator of health monitor objects
update_health_monitor
(health_monitor, **attrs)Update a health monitor
health_monitor – Either the id of a health monitor or a
HealthMonitor
instance.
attrs (dict) – The attributes to update on the health monitor
represented by value
.
The updated health monitor
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_metering_label
(**attrs)Create a new metering label from attributes
attrs (dict) – Keyword arguments which will be used to create
a MeteringLabel
,
comprised of the properties on the MeteringLabel class.
The results of metering label creation
delete_metering_label
(metering_label, ignore_missing=True)Delete a metering label
metering_label – The value can be either the ID of a metering label or a
MeteringLabel
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the metering label does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent metering label.
None
find_metering_label
(name_or_id, ignore_missing=True, **args)Find a single metering label
name_or_id – The name or ID of a metering label.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
MeteringLabel
or None
get_metering_label
(metering_label)Get a single metering label
metering_label – The value can be the ID of a metering label or a
MeteringLabel
instance.
One
MeteringLabel
ResourceNotFound
when no resource can be found.
metering_labels
(**query)Return a generator of metering labels
query (dict) –
the resources being returned. Valid parameters are:
description
: Description of a metering label.
name
: Name of a metering label.
is_shared
: Boolean indicating whether a metering label isshared.
project_id
: The ID of the project a metering label isassociated with.
A generator of metering label objects
update_metering_label
(metering_label, **attrs)Update a metering label
metering_label – Either the id of a metering label or a
MeteringLabel
instance.
attrs (dict) – The attributes to update on the metering label
represented by metering_label
.
The updated metering label
create_metering_label_rule
(**attrs)Create a new metering label rule from attributes
attrs (dict) – Keyword arguments which will be used to create a
MeteringLabelRule
, comprised of the properties on
the MeteringLabelRule class.
The results of metering label rule creation
MeteringLabelRule
delete_metering_label_rule
(metering_label_rule, ignore_missing=True)Delete a metering label rule
metering_label_rule – The value can be either the ID of a metering label rule
or a MeteringLabelRule
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised
when the metering label rule does not exist. When set to True
,
no exception will be set when attempting to delete a nonexistent
metering label rule.
None
find_metering_label_rule
(name_or_id, ignore_missing=True, **args)Find a single metering label rule
name_or_id – The name or ID of a metering label rule.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
MeteringLabelRule
or None
get_metering_label_rule
(metering_label_rule)Get a single metering label rule
metering_label_rule – The value can be the ID of a metering label rule or a
MeteringLabelRule
instance.
One
MeteringLabelRule
ResourceNotFound
when no resource can be found.
metering_label_rules
(**query)Return a generator of metering label rules
query (dict) –
the resources being returned. Valid parameters are:
direction
: The direction in which metering label rule isapplied.
metering_label_id
: The ID of a metering label this rule isassociated with.
project_id
: The ID of the project the metering label rule isassociated with.
remote_ip_prefix
: The remote IP prefix to be associated withthis metering label rule.
A generator of metering label rule objects
MeteringLabelRule
update_metering_label_rule
(metering_label_rule, **attrs)Update a metering label rule
metering_label_rule – Either the id of a metering label rule or a
MeteringLabelRule
instance.
attrs (dict) – The attributes to update on the metering label rule
represented by metering_label_rule
.
The updated metering label rule
MeteringLabelRule
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_segment
(**attrs)Create a new segment from attributes
delete_segment
(segment, ignore_missing=True)Delete a segment
segment – The value can be either the ID of a segment or a
Segment
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the segment does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent segment.
None
find_segment
(name_or_id, ignore_missing=True, **args)Find a single segment
name_or_id – The name or ID of a segment.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Segment
or None
get_segment
(segment)Get a single segment
segments
(**query)Return a generator of segments
query (kwargs) –
Optional query parameters to be sent to limit the resources being returned. Available parameters include:
description
: The segment description
name
: Name of the segments
network_id
: ID of the network that owns the segments
network_type
: Network type for the segments
physical_network
: Physical network name for the segments
segmentation_id
: Segmentation ID for the segments
A generator of segment objects
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_flavor
(**attrs)Create a new network service flavor from attributes
delete_flavor
(flavor, ignore_missing=True)Delete a network service flavor
flavor – The value can be either the ID of a flavor or a
Flavor
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the flavor does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent flavor.
None
find_flavor
(name_or_id, ignore_missing=True, **args)Find a single network service flavor
name_or_id – The name or ID of a flavor.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Flavor
or None
get_flavor
(flavor)Get a single network service flavor
update_flavor
(flavor, **attrs)Update a network service flavor
flavors
(**query)Return a generator of network service flavors
query (dict) –
the resources being returned. Valid parameters include:
description
: The description of a flavor.
is_enabled
: Whether a flavor is enabled.
name
: The name of a flavor.
service_type
: The service type to which a falvor applies.
A generator of flavor objects
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)associate_flavor_with_service_profile
(flavor, service_profile)Associate network flavor with service profile.
flavor – Either the id of a flavor or a
Flavor
instance.
service_profile – The value can be either the ID of a service profile or a
ServiceProfile
instance.
disassociate_flavor_from_service_profile
(flavor, service_profile)Disassociate network flavor from service profile.
flavor – Either the id of a flavor or a
Flavor
instance.
service_profile – The value can be either the ID of a service profile or a
ServiceProfile
instance.
create_service_profile
(**attrs)Create a new network service flavor profile from attributes
attrs (dict) – Keyword arguments which will be used to create
a ServiceProfile
,
comprised of the properties on the ServiceProfile
class.
The results of service profile creation
delete_service_profile
(service_profile, ignore_missing=True)Delete a network service flavor profile
service_profile – The value can be either the ID of a service
profile or a
ServiceProfile
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the service profile does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent service profile.
None
find_service_profile
(name_or_id, ignore_missing=True, **args)Find a single network service flavor profile
name_or_id – The name or ID of a service profile.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One ServiceProfile
or None
get_service_profile
(service_profile)Get a single network service flavor profile
service_profile – The value can be the ID of a service_profile or
a ServiceProfile
instance.
One ServiceProfile
ResourceNotFound
when no resource can be found.
service_profiles
(**query)Return a generator of network service flavor profiles
query (dict) –
resources returned. Available parameters inclue:
description
: The description of the service flavor profile
driver
: Provider driver for the service flavor profile
is_enabled
: Whether the profile is enabled
project_id
: The owner project ID
A generator of service profile objects
update_service_profile
(service_profile, **attrs)Update a network flavor service profile
service_profile – Either the id of a service profile or a
ServiceProfile
instance.
The attributes to update on the service profile
represented by value
.
The updated service profile
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_vpn_service
(**attrs)Create a new vpn service from attributes
attrs (dict) – Keyword arguments which will be used to create
a VPNService
,
comprised of the properties on the VPNService class.
The results of vpn service creation
VPNService
delete_vpn_service
(vpn_service, ignore_missing=True)Delete a vpn service
vpn_service – The value can be either the ID of a vpn service or a
VPNService
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the vpn service does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent vpn service.
None
find_vpn_service
(name_or_id, ignore_missing=True, **args)Find a single vpn service
name_or_id – The name or ID of a vpn service.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One VPNService
or None
get_vpn_service
(vpn_service)Get a single vpn service
vpn_service – The value can be the ID of a vpn service or a
VPNService
instance.
One
VPNService
ResourceNotFound
when no resource can be found.
vpn_services
(**query)Return a generator of vpn services
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of vpn service objects
VPNService
update_vpn_service
(vpn_service, **attrs)Update a vpn service
vpn_service – Either the id of a vpn service or a
VPNService
instance.
attrs (dict) – The attributes to update on the VPN service
represented by vpn_service
.
The updated vpnservice
VPNService
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_vpn_ipsec_site_connection
(**attrs)Create a new ipsec site connection from attributes
attrs (dict) – Keyword arguments which will be used to create a
IPSecSiteConnection
, comprised of the properties on the
IPSecSiteConnection class.
The results of ipsec site connection creation :rtype:
IPSecSiteConnection
find_vpn_ipsec_site_connection
(name_or_id, ignore_missing=True, **args)Find a single ipsec site connection
name_or_id – The name or ID of an ipsec site connection.
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised when the resource does
not exist.When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods such as query filters.
One
IPSecSiteConnection
or None
get_vpn_ipsec_site_connection
(ipsec_site_connection)Get a single ipsec site connection
ipsec_site_connection – The value can be the ID of an ipsec site
connection or a IPSecSiteConnection
instance.
One
IPSecSiteConnection
ResourceNotFound
when no resource can be found.
vpn_ipsec_site_connections
(**query)Return a generator of ipsec site connections
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of ipsec site connection objects
IPSecSiteConnection
update_vpn_ipsec_site_connection
(ipsec_site_connection, **attrs)Update a ipsec site connection
Either the id of an ipsec site connection or
a
IPSecSiteConnection
instance.
attrs (dict) – The attributes to update on the ipsec site
connection represented by ipsec_site_connection
.
The updated ipsec site connection
IPSecSiteConnection
delete_vpn_ipsec_site_connection
(ipsec_site_connection, ignore_missing=True)Delete a ipsec site connection
ipsec_site_connection – The value can be either the ID of an
ipsec site connection, or a IPSecSiteConnection
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised when the ipsec site connection
does not exist.
When set to True
, no exception will be set when attempting to
delete a nonexistent ipsec site connection.
None
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)find_extension
(name_or_id, ignore_missing=True, **args)Find a single extension
name_or_id – The name or ID of a extension.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
args (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Extension
or None
extensions
(**query)Return a generator of extensions
query (dict) – Optional query parameters to be sent to limit the resources being returned. Currently no parameter is supported.
A generator of extension objects
openstack.network.v2._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)service_providers
(**query)Return a generator of service providers
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of service provider objects
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.