Network API¶
For details on how to use network, see Using OpenStack Network
The Network Class¶
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.
Network Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session)¶ -
create_network
(**attrs)¶ Create a new network from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a Network
, comprised of the properties on the Network class.Returns: The results of network creation Return type: Network
-
update_network
(network, **attrs)¶ Update a network
Parameters: - network – Either the id of a network or an instance of type
Network
. - attrs (dict) – The attributes to update on the network represented
by
network
.
Returns: The updated network
Return type: - network – Either the id of a network or an instance of type
-
delete_network
(network, ignore_missing=True)¶ Delete a network
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent network.
Returns: None
- network – The value can be either the ID of a network or a
-
get_network
(network)¶ Get a single network
Parameters: network – The value can be the ID of a network or a Network
instance.Returns: One Network
Raises: ResourceNotFound
when no resource can be found.
-
find_network
(name_or_id, ignore_missing=True)¶ Find a single network
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
Network
or None
-
networks
(**query)¶ Return a generator of networks
Parameters: **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 for- the network.
ipv6_address_scope_id
: The ID of the IPv6 address scope for- the network.
is_admin_state_up
: Network administrative stateis_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 statusproject_id
: Owner tenant IDprovider_network_type
: Network physical mechanismprovider_physical_network
: Physical networkprovider_segmentation_id
: VLAN ID for VLAN networks or Tunnel- ID for GENEVE/GRE/VXLAN networks
Returns: A generator of network objects Return type: Network
-
get_network_ip_availability
(network)¶ Get IP availability of a network
Parameters: network – The value can be the ID of a network or a Network
instance.Returns: One NetworkIPAvailability
Raises: ResourceNotFound
when no resource can be found.
-
find_network_ip_availability
(name_or_id, ignore_missing=True)¶ Find IP availability of a network
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
NetworkIPAvailability
or None
-
network_ip_availabilities
(**query)¶ Return a generator of network ip availabilities
Parameters: **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. Available parameters include:
ip_version
: IP version of the networknetwork_id
: ID of network to use when listening network IP- availability.
network_name
: The name of the network for the particular- network IP availability.
project_id
: Owner tenant ID
Returns: A generator of network ip availability objects Return type: NetworkIPAvailability
-
add_dhcp_agent_to_network
(agent, network)¶ Add a DHCP Agent to a network
Parameters: - agent – Either the agent id of an instance of
Agent
- network – Network instance
Returns: - agent – Either the agent id of an instance of
-
remove_dhcp_agent_from_network
(agent, network)¶ Remove a DHCP Agent from a network
Parameters: - agent – Either the agent id of an instance of
Agent
- network – Network instance
Returns: - agent – Either the agent id of an instance of
-
dhcp_agent_hosting_networks
(agent, **query)¶ A generator of networks hosted by a DHCP agent.
Parameters: - 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.
Returns: A generator of networks
- agent – Either the agent id of an instance of
-
Port Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_port
(**attrs)¶ Create a new port from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a Port
, comprised of the properties on the Port class.Returns: The results of port creation Return type: Port
-
update_port
(port, **attrs)¶ Update a port
Parameters: - port – Either the id of a port or a
Port
instance. - attrs (dict) – The attributes to update on the port represented
by
port
.
Returns: The updated port
Return type: - port – Either the id of a port or a
-
delete_port
(port, ignore_missing=True)¶ Delete a port
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent port.
Returns: None
- port – The value can be either the ID of a port or a
-
get_port
(port)¶ Get a single port
Parameters: port – The value can be the ID of a port or a Port
instance.Returns: One Port
Raises: ResourceNotFound
when no resource can be found.
-
find_port
(name_or_id, ignore_missing=True)¶ Find a single port
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
Port
or None
-
ports
(**query)¶ Return a generator of ports
Parameters: **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 isACTIVE
orDOWN
.subnet_id
: The ID of the subnet.
Returns: A generator of port objects Return type: Port
-
add_ip_to_port
(port, ip)¶
-
remove_ip_from_port
(ip)¶
-
Router Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_router
(**attrs)¶ Create a new router from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a Router
, comprised of the properties on the Router class.Returns: The results of router creation Return type: Router
-
update_router
(router, **attrs)¶ Update a router
Parameters: - router – Either the id of a router or a
Router
instance. - attrs (dict) – The attributes to update on the router represented
by
router
.
Returns: The updated router
Return type: - router – Either the id of a router or a
-
delete_router
(router, ignore_missing=True)¶ Delete a router
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent router.
Returns: None
- router – The value can be either the ID of a router or a
-
get_router
(router)¶ Get a single router
Parameters: router – The value can be the ID of a router or a Router
instance.Returns: One Router
Raises: ResourceNotFound
when no resource can be found.
-
find_router
(name_or_id, ignore_missing=True)¶ Find a single router
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
Router
or None
-
routers
(**query)¶ Return a generator of routers
Parameters: query (dict) – - Optional query parameters to be sent to limit
- 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 notis_distributed
: The distributed state of a routeris_ha
: The highly-available state of a routername
: Router nameproject_id
: The ID of the project this router is associated- with.
status
: The status of the router.
Returns: A generator of router objects Return type: Router
-
add_gateway_to_router
(router, **body)¶ Add Gateway to a router
Parameters: - router – Either the router ID or an instance of
Router
- body – Body with the gateway information
Returns: Router with updated interface
Return type: class: ~openstack.network.v2.router.Router - router – Either the router ID or an instance of
-
remove_gateway_from_router
(router, **body)¶ Remove Gateway from a router
Parameters: - router – Either the router ID or an instance of
Router
- body – Body with the gateway information
Returns: Router with updated interface
Return type: class: ~openstack.network.v2.router.Router - router – Either the router ID or an instance of
-
add_interface_to_router
(router, subnet_id=None, port_id=None)¶ Add Interface to a router
Parameters: - router – Either the router ID or an instance of
Router
- subnet_id – ID of the subnet
- port_id – ID of the port
Returns: Router with updated interface
Return type: class: ~openstack.network.v2.router.Router - router – Either the router ID or an instance of
-
remove_interface_from_router
(router, subnet_id=None, port_id=None)¶ Remove Interface from a router
Parameters: - router – Either the router ID or an instance of
Router
- subnet – ID of the subnet
- port – ID of the port
Returns: Router with updated interface
Return type: class: ~openstack.network.v2.router.Router - router – Either the router ID or an instance of
-
Floating IP Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_ip
(**attrs)¶ Create a new floating ip from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a FloatingIP
, comprised of the properties on the FloatingIP class.Returns: The results of floating ip creation Return type: FloatingIP
-
update_ip
(floating_ip, **attrs)¶ Update a ip
Parameters: - floating_ip – Either the id of a ip or a
FloatingIP
instance. - attrs (dict) – The attributes to update on the ip represented
by
value
.
Returns: The updated ip
Return type: - floating_ip – Either the id of a ip or a
-
delete_ip
(floating_ip, ignore_missing=True)¶ Delete a floating ip
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent ip.
Returns: None
- floating_ip – The value can be either the ID of a floating ip
or a
-
get_ip
(floating_ip)¶ Get a single floating ip
Parameters: floating_ip – The value can be the ID of a floating ip or a FloatingIP
instance.Returns: One FloatingIP
Raises: ResourceNotFound
when no resource can be found.
-
find_ip
(name_or_id, ignore_missing=True)¶ Find a single IP
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
FloatingIP
or None
-
find_available_ip
()¶ Find an available IP
Returns: One FloatingIP
or None
-
ips
(**query)¶ Return a generator of ips
Parameters: query (dict) – - Optional query parameters to be sent to limit
- the resources being returned. Valid parameters are:
description
: The description of a floating IP.fixed_ip_address
: The fixed IP address associated with a- floating IP address.
floating_ip_address
: The IP address of a floating IP.floating_network_id
: The ID of the network associated with- a floating IP.
port_id
: The ID of the port to which a floating IP is- associated.
project_id
: The ID of the project a floating IP is- associated with.
router_id
: The ID of an associated router.status
: The status of a floating IP, which can beACTIVE
- or
DOWN
.
Returns: A generator of floating IP objects Return type: FloatingIP
-
Pool Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_pool
(**attrs)¶ Create a new pool from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a Pool
, comprised of the properties on the Pool class.Returns: The results of pool creation Return type: Pool
-
update_pool
(pool, **attrs)¶ Update a pool
Parameters: - pool – Either the id of a pool or a
Pool
instance. - attrs (dict) – The attributes to update on the pool represented
by
pool
.
Returns: The updated pool
Return type: - pool – Either the id of a pool or a
-
delete_pool
(pool, ignore_missing=True)¶ Delete a pool
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent pool.
Returns: None
- pool – The value can be either the ID of a pool or a
-
get_pool
(pool)¶ Get a single pool
Parameters: pool – The value can be the ID of a pool or a Pool
instance.Returns: One Pool
Raises: ResourceNotFound
when no resource can be found.
-
find_pool
(name_or_id, ignore_missing=True)¶ Find a single pool
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
Pool
or None
-
pools
(**query)¶ Return a generator of pools
Parameters: query (dict) – - Optional query parameters to be sent to limit
- 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 one- of
round-robin
,least-connections
and so on.
name
: The name of the node pool.project_id
: The ID of the project the pool is associated- with.
protocol
: The protocol used by the pool, which is one ofTCP
,HTTP
orHTTPS
.
provider
: The name of the provider of the load balancer- service.
subnet_id
: The subnet on which the members of the pool are- located.
virtual_ip_id
: The ID of the virtual IP used.
Returns: A generator of pool objects Return type: Pool
-
create_pool_member
(pool, **attrs)¶ Create a new pool member from attributes
Parameters: - 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.
Returns: The results of pool member creation
Return type: - pool – The pool can be either the ID of a pool or a
-
update_pool_member
(pool_member, pool, **attrs)¶ Update a pool member
Parameters: - 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
.
Returns: The updated pool member
Return type: - pool_member – Either the ID of a pool member or a
-
delete_pool_member
(pool_member, pool, ignore_missing=True)¶ Delete a pool member
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent pool member.
Returns: None
- pool_member – The member can be either the ID of a pool member or a
-
get_pool_member
(pool_member, pool)¶ Get a single pool member
Parameters: - 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.
Returns: One
PoolMember
Raises: ResourceNotFound
when no resource can be found.- pool_member – The member can be the ID of a pool member or a
-
find_pool_member
(name_or_id, pool, ignore_missing=True)¶ Find a single pool member
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
PoolMember
or None
-
pool_members
(pool, **query)¶ Return a generator of pool members
Parameters: - pool – The pool can be either the ID of a pool or a
Pool
instance that the member belongs to. - query (dict) –
- Optional query parameters to be sent to limit
- the resources being returned. Valid parameters are:
address
: The IP address of the pool member.is_admin_state_up
: The administrative state of the pool- member.
name
: Name of the pool member.project_id
: The ID of the project this pool member is- associated 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 relative- portion of traffic that this member should receive from the pool.
Returns: A generator of pool member objects
Return type: - pool – The pool can be either the ID of a pool or a
-
Auto Allocated Topology Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
delete_auto_allocated_topology
(project=None, ignore_missing=False)¶ Delete auto-allocated topology
Parameters: - 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 toTrue
, no exception will be raised when attempting to delete nonexistant topology
Returns: None
-
get_auto_allocated_topology
(project=None)¶ Get the auto-allocated topology of a given tenant
Parameters: project – The value is the ID or name of a project Returns: The auto-allocated topology Return type: AutoAllocatedTopology
-
validate_auto_allocated_topology
(project=None)¶ Validate the resources for auto allocation
Parameters: project – The value is the ID or name of a project Returns: Whether all resources are correctly configured or not Return type: ValidateTopology
-
Security Group Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_security_group
(**attrs)¶ Create a new security group from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a SecurityGroup
, comprised of the properties on the SecurityGroup class.Returns: The results of security group creation Return type: SecurityGroup
-
update_security_group
(security_group, **attrs)¶ Update a security group
Parameters: - security_group – Either the id of a security group or a
SecurityGroup
instance. - attrs (dict) – The attributes to update on the security group
represented by
security_group
.
Returns: The updated security group
Return type: - security_group – Either the id of a security group or a
-
delete_security_group
(security_group, ignore_missing=True)¶ Delete a security group
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent security group.
Returns: None
- security_group – The value can be either the ID of a security group or a
-
get_security_group
(security_group)¶ Get a single security group
Parameters: security_group – The value can be the ID of a security group or a SecurityGroup
instance.Returns: One SecurityGroup
Raises: ResourceNotFound
when no resource can be found.
-
get_security_group_rule
(security_group_rule)¶ Get a single security group rule
Parameters: security_group_rule – The value can be the ID of a security group rule or a SecurityGroupRule
instance.Returns: SecurityGroupRule
Raises: ResourceNotFound
when no resource can be found.
-
find_security_group
(name_or_id, ignore_missing=True)¶ Find a single security group
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
SecurityGroup
or None
-
find_security_group_rule
(name_or_id, ignore_missing=True)¶ Find a single security group rule
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
SecurityGroupRule
or None
-
security_group_rules
(**query)¶ Return a generator of security group rules
Parameters: **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. Available parameters include:
description
: The security group rule descriptiondirection
: Security group rule directionether_type
: Must be IPv4 or IPv6, and addresses represented- in CIDR must match the ingress or egress rule.
project_id
: The ID of the project this security group rule- is associated with.
protocol
: Security group rule protocolremote_group_id
: ID of a remote security groupsecurity_group_id
: ID of security group that owns the rules
Returns: A generator of security group rule objects Return type: SecurityGroupRule
-
security_groups
(**query)¶ Return a generator of security groups
Parameters: query (dict) – - Optional query parameters to be sent to limit
- the resources being returned. Valid parameters are:
description
: Security group descriptionname
: The name of a security groupproject_id
: The ID of the project this security group is- associated with.
Returns: A generator of security group objects Return type: SecurityGroup
-
security_group_allow_ping
(*args, **kwargs)¶ Deprecated in 0.9.14, to be removed in 1.0. See the Network user guide for an example
-
security_group_open_port
(*args, **kwargs)¶ Deprecated in 0.9.14, to be removed in 1.0. See the Network user guide for an example
-
create_security_group_rule
(**attrs)¶ Create a new security group rule from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a SecurityGroupRule
, comprised of the properties on the SecurityGroupRule class.Returns: The results of security group rule creation Return type: SecurityGroupRule
-
delete_security_group_rule
(security_group_rule, ignore_missing=True)¶ Delete a security group rule
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent security group rule.
Returns: None
- security_group_rule – The value can be either the ID of a security group rule
or a
-
Availability Zone Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
availability_zones
(**query)¶ Return a generator of availability zones
Parameters: query (dict) – - optional query parameters to be set to limit the
- returned resources. Valid parameters include:
name
: The name of an availability zone.resource
: The type of resource for the availability zone.
Returns: A generator of availability zone objects Return type: AvailabilityZone
-
Address Scope Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_address_scope
(**attrs)¶ Create a new address scope from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a AddressScope
, comprised of the properties on the AddressScope class.Returns: The results of address scope creation Return type: AddressScope
-
update_address_scope
(address_scope, **attrs)¶ Update an address scope
Parameters: - 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
.
Returns: The updated address scope
Return type: - address_scope – Either the ID of an address scope or a
-
delete_address_scope
(address_scope, ignore_missing=True)¶ Delete an address scope
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent address scope.
Returns: None
- address_scope – The value can be either the ID of an
address scope or
a
-
get_address_scope
(address_scope)¶ Get a single address scope
Parameters: address_scope – The value can be the ID of an address scope or a AddressScope
instance.Returns: One AddressScope
Raises: ResourceNotFound
when no resource can be found.
-
find_address_scope
(name_or_id, ignore_missing=True)¶ Find a single address scope
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
AddressScope
or None
-
address_scopes
(**query)¶ Return a generator of address scopes
Parameters: query (dict) – - Optional query parameters to be sent to limit
- the resources being returned.
name
: Address scope nameip_version
: Address scope IP address versiontenant_id
: Owner tenant IDshared
: Address scope is shared (boolean)
Returns: A generator of address scope objects Return type: AddressScope
-
Quota Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
update_quota
(quota, **attrs)¶ Update a quota
Parameters: - quota – 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. - attrs (dict) – The attributes to update on the quota represented
by
quota
.
Returns: The updated quota
Return type: - quota – Either the ID of a quota or a
-
delete_quota
(quota, ignore_missing=True)¶ Delete a quota (i.e. reset to the default quota)
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent quota.
Returns: None
- quota – The value can be either the ID of a quota or a
-
get_quota
(quota)¶ Get a quota
Parameters: quota – The value can be the ID of a quota or a Quota
instance. The ID of a quota is the same as the project ID for the quota.Returns: One Quota
Raises: ResourceNotFound
when no resource can be found.
-
get_quota_default
(quota)¶ Get a default quota
Parameters: 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.Returns: One QuotaDefault
Raises: ResourceNotFound
when no resource can be found.
-
QoS Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_qos_policy
(**attrs)¶ Create a new QoS policy from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a QoSPolicy
, comprised of the properties on the QoSPolicy class.Returns: The results of QoS policy creation Return type: QoSPolicy
-
update_qos_policy
(qos_policy, **attrs)¶ Update a QoS policy
Parameters: qos_policy – Either the id of a QoS policy or a QoSPolicy
instance.Attrs kwargs: The attributes to update on the QoS policy represented by value
.Returns: The updated QoS policy Return type: QoSPolicy
-
delete_qos_policy
(qos_policy, ignore_missing=True)¶ Delete a QoS policy
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent QoS policy.
Returns: None
- qos_policy – The value can be either the ID of a QoS policy or a
-
get_qos_policy
(qos_policy)¶ Get a single QoS policy
Parameters: qos_policy – The value can be the ID of a QoS policy or a QoSPolicy
instance.Returns: One QoSPolicy
Raises: ResourceNotFound
when no resource can be found.
-
find_qos_policy
(name_or_id, ignore_missing=True)¶ Find a single QoS policy
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
QoSPolicy
or None
-
qos_policies
(**query)¶ Return a generator of QoS policies
Parameters: query (dict) – - Optional query parameters to be sent to limit
- 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.
Returns: A generator of QoS policy objects Return type: QoSPolicy
-
qos_rule_types
(**query)¶ Return a generator of QoS rule types
Parameters: query (dict) – - Optional query parameters to be sent to limit the
- resources returned. Valid parameters include:
type
: The type of the QoS rule type.
Returns: A generator of QoS rule type objects Return type: QoSRuleType
-
create_qos_minimum_bandwidth_rule
(qos_policy, **attrs)¶ Create a new minimum bandwidth rule
Parameters: - 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.
Returns: The results of resource creation
Return type: QoSMinimumBandwidthRule
- attrs (dict) – Keyword arguments which will be used to create
a
-
update_qos_minimum_bandwidth_rule
(qos_rule, qos_policy, **attrs)¶ Update a minimum bandwidth rule
Parameters: - 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.
Attrs kwargs: The attributes to update on the minimum bandwidth rule represented by
value
.Returns: The updated minimum bandwidth rule
Return type: QoSMinimumBandwidthRule
- qos_rule – Either the id of a minimum bandwidth rule or a
-
delete_qos_minimum_bandwidth_rule
(qos_rule, qos_policy, ignore_missing=True)¶ Delete a minimum bandwidth rule
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent minimum bandwidth rule.
Returns: None
- qos_rule – The value can be either the ID of a minimum bandwidth
rule or a
-
get_qos_minimum_bandwidth_rule
(qos_rule, qos_policy)¶ Get a single minimum bandwidth rule
Parameters: - 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.
Returns: One
QoSMinimumBandwidthRule
Raises: ResourceNotFound
when no resource can be found.- qos_rule – The value can be the ID of a minimum bandwidth rule or
a
-
find_qos_minimum_bandwidth_rule
(qos_rule_id, qos_policy, ignore_missing=True)¶ Find a minimum bandwidth rule
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
QoSMinimumBandwidthRule
or None
-
qos_minimum_bandwidth_rules
(qos_policy, **query)¶ Return a generator of minimum bandwidth rules
Parameters: - 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.
Returns: A generator of minimum bandwidth rule objects
Return type: QoSMinimumBandwidthRule
- qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a
-
create_qos_bandwidth_limit_rule
(qos_policy, **attrs)¶ Create a new bandwidth limit rule
Parameters: - 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.
Returns: The results of resource creation
Return type: QoSBandwidthLimitRule
- attrs (dict) – Keyword arguments which will be used to create
a
-
update_qos_bandwidth_limit_rule
(qos_rule, qos_policy, **attrs)¶ Update a bandwidth limit rule
Parameters: - 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.
Attrs kwargs: The attributes to update on the bandwidth limit rule represented by
value
.Returns: The updated minimum bandwidth rule
Return type: QoSBandwidthLimitRule
- qos_rule – Either the id of a bandwidth limit rule or a
-
delete_qos_bandwidth_limit_rule
(qos_rule, qos_policy, ignore_missing=True)¶ Delete a bandwidth limit rule
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent bandwidth limit rule.
Returns: None
- qos_rule – The value can be either the ID of a bandwidth limit
rule or a
-
get_qos_bandwidth_limit_rule
(qos_rule, qos_policy)¶ Get a single bandwidth limit rule
Parameters: - 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.
Returns: One
QoSBandwidthLimitRule
Raises: ResourceNotFound
when no resource can be found.- qos_rule – The value can be the ID of a minimum bandwidth rule or
a
-
find_qos_bandwidth_limit_rule
(qos_rule_id, qos_policy, ignore_missing=True)¶ Find a bandwidth limit rule
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
QoSBandwidthLimitRule
or None
-
qos_bandwidth_limit_rules
(qos_policy, **query)¶ Return a generator of bandwidth limit rules
Parameters: - 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.
Returns: A generator of bandwidth limit rule objects
Return type: QoSBandwidthLimitRule
- qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a
-
create_qos_dscp_marking_rule
(qos_policy, **attrs)¶ Create a new QoS DSCP marking rule
Parameters: - 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.
Returns: The results of router creation
Return type: QoSDSCPMarkingRule
- attrs (dict) – Keyword arguments which will be used to create
a
-
update_qos_dscp_marking_rule
(qos_rule, qos_policy, **attrs)¶ Update a QoS DSCP marking rule
Parameters: - 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.
Attrs kwargs: The attributes to update on the QoS DSCP marking rule represented by
value
.Returns: The updated QoS DSCP marking rule
Return type: QoSDSCPMarkingRule
- qos_rule – Either the id of a minimum bandwidth rule or a
-
delete_qos_dscp_marking_rule
(qos_rule, qos_policy, ignore_missing=True)¶ Delete a QoS DSCP marking rule
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent minimum bandwidth rule.
Returns: None
- qos_rule – The value can be either the ID of a minimum bandwidth
rule or a
-
get_qos_dscp_marking_rule
(qos_rule, qos_policy)¶ Get a single QoS DSCP marking rule
Parameters: - 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.
Returns: One
QoSDSCPMarkingRule
Raises: ResourceNotFound
when no resource can be found.- qos_rule – The value can be the ID of a minimum bandwidth rule or
a
-
find_qos_dscp_marking_rule
(qos_rule_id, qos_policy, ignore_missing=True)¶ Find a QoS DSCP marking rule
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
QoSDSCPMarkingRule
or None
-
qos_dscp_marking_rules
(qos_policy, **query)¶ Return a generator of QoS DSCP marking rules
Parameters: - 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.
Returns: A generator of QoS DSCP marking rule objects
Return type: QoSDSCPMarkingRule
- qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a
-
Agent Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
delete_agent
(agent, ignore_missing=True)¶ Delete a network agent
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent agent.
Returns: None
- agent – The value can be the ID of a agent or a
-
update_agent
(agent, **attrs)¶ Update a network agent
Parameters: - agent – The value can be the ID of a agent or a
Agent
instance. - attrs (dict) – The attributes to update on the agent represented
by
value
.
Returns: One
Agent
Return type: - agent – The value can be the ID of a agent or a
-
get_agent
(agent)¶ Get a single network agent
Parameters: agent – The value can be the ID of a agent or a Agent
instance.Returns: One Agent
Return type: Agent
Raises: ResourceNotFound
when no resource can be found.
-
agents
(**query)¶ Return a generator of network agents
Parameters: query (dict) – - Optional query parameters to be sent to limit the
- 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 is- running on.
topic
: The message queue topic used.is_admin_state_up
: The administrative state of the agent.is_alive
: Whether the agent is alive.
Returns: A generator of agents Return type: Agent
-
agent_hosted_routers
(agent, **query)¶ Return a generator of routers hosted by a L3 agent
Parameters: - agent – Either the agent id of an instance of
Agent
- **query (kwargs) – Optional query parameters to be sent to limit the resources returned
Returns: A generator of routers
Return type: L3AgentRouters
- agent – Either the agent id of an instance of
-
routers_hosting_l3_agents
(router, **query)¶ Return a generator of L3 agent hosting a router
Parameters: - router – Either the router id or an instance of
Router
- **query (kwargs) – Optional query parameters to be sent to limit the resources returned
Returns: A generator of Router L3 Agents
Return type: RouterL3Agents
- router – Either the router id or an instance of
-
network_hosting_dhcp_agents
(network, **query)¶ A generator of DHCP agents hosted on a network.
Parameters: - network – The instance of
Network
- query (dict) – Optional query parameters to be sent to limit the resources returned.
Returns: A generator of hosted DHCP agents
- network – The instance of
-
RBAC Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_rbac_policy
(**attrs)¶ Create a new RBAC policy from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a RBACPolicy
, comprised of the properties on the RBACPolicy class.Returns: The results of RBAC policy creation Return type: RBACPolicy
-
update_rbac_policy
(rbac_policy, **attrs)¶ Update a RBAC policy
Parameters: - 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
.
Returns: The updated RBAC policy
Return type: - rbac_policy – Either the id of a RBAC policy or a
-
delete_rbac_policy
(rbac_policy, ignore_missing=True)¶ Delete a RBAC policy
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent RBAC policy.
Returns: None
- rbac_policy – The value can be either the ID of a RBAC policy or
a
-
get_rbac_policy
(rbac_policy)¶ Get a single RBAC policy
Parameters: rbac_policy – The value can be the ID of a RBAC policy or a RBACPolicy
instance.Returns: One RBACPolicy
Raises: ResourceNotFound
when no resource can be found.
-
find_rbac_policy
(rbac_policy, ignore_missing=True)¶ Find a single RBAC policy
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
RBACPolicy
or None
-
rbac_policies
(**query)¶ Return a generator of RBAC policies
Parameters: query (dict) – - Optional query parameters to be sent to limit
- the resources being returned. Available parameters include:
action
: RBAC policy actionobject_type
: Type of the object that the RBAC policy affectstarget_project_id
: ID of the tenant that the RBAC policy- affects
project_id
: Owner tenant ID
Returns: A generator of rbac objects Return type: RBACPolicy
-
Listener Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_listener
(**attrs)¶ Create a new listener from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a Listener
, comprised of the properties on the Listener class.Returns: The results of listener creation Return type: Listener
-
update_listener
(listener, **attrs)¶ Update a listener
Parameters: - listener – Either the id of a listener or a
Listener
instance. - attrs (dict) – The attributes to update on the listener
represented by
listener
.
Returns: The updated listener
Return type: - listener – Either the id of a listener or a
-
delete_listener
(listener, ignore_missing=True)¶ Delete a listener
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent listener.
Returns: None
- listener – The value can be either the ID of a listner or a
-
get_listener
(listener)¶ Get a single listener
Parameters: listener – The value can be the ID of a listener or a Listener
instance.Returns: One Listener
Raises: ResourceNotFound
when no resource can be found.
-
find_listener
(name_or_id, ignore_missing=True)¶ Find a single listener
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
Listener
or None
-
listeners
(**query)¶ Return a generator of listeners
Parameters: query (dict) – - Optional query parameters to be sent to limit
- the resources being returned. Valid parameters are:
connection_limit
: The maximum number of connections- permitted for the load-balancer.
default_pool_id
: The ID of the default pool.default_tls_container_ref
: A reference to a container of TLS- secret.
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.
Returns: A generator of listener objects Return type: Listener
-
Subnet Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_subnet
(**attrs)¶ Create a new subnet from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a Subnet
, comprised of the properties on the Subnet class.Returns: The results of subnet creation Return type: Subnet
-
update_subnet
(subnet, **attrs)¶ Update a subnet
Parameters: - subnet – Either the id of a subnet or a
Subnet
instance. - attrs (dict) – The attributes to update on the subnet represented
by
subnet
.
Returns: The updated subnet
Return type: - subnet – Either the id of a subnet or a
-
delete_subnet
(subnet, ignore_missing=True)¶ Delete a subnet
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent subnet.
Returns: None
- subnet – The value can be either the ID of a subnet or a
-
get_subnet
(subnet)¶ Get a single subnet
Parameters: subnet – The value can be the ID of a subnet or a Subnet
instance.Returns: One Subnet
Raises: ResourceNotFound
when no resource can be found.
-
get_subnet_ports
(subnet_id)¶
-
find_subnet
(name_or_id, ignore_missing=True)¶ Find a single subnet
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
Subnet
or None
-
subnets
(**query)¶ Return a generator of subnets
Parameters: query (dict) – Optional query parameters to be sent to limit the resources being returned. Available parameters include:
cidr
: Subnet CIDRdescription
: The subnet descriptiongateway_ip
: Subnet gateway IP addressip_version
: Subnet IP address versionipv6_address_mode
: The IPv6 adress modeipv6_ra_mode
: The IPv6 router advertisement modeis_dhcp_enabled
: Subnet has DHCP enabled (boolean)name
: Subnet namenetwork_id
: ID of network that owns the subnetsproject_id
: Owner tenant IDsubnet_pool_id
: The subnet pool ID from which to obtain a- CIDR.
Returns: A generator of subnet objects Return type: Subnet
-
create_subnet_pool
(**attrs)¶ Create a new subnet pool from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a SubnetPool
, comprised of the properties on the SubnetPool class.Returns: The results of subnet pool creation Return type: SubnetPool
-
update_subnet_pool
(subnet_pool, **attrs)¶ Update a subnet pool
Parameters: - 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
.
Returns: The updated subnet pool
Return type: - subnet_pool – Either the ID of a subnet pool or a
-
delete_subnet_pool
(subnet_pool, ignore_missing=True)¶ Delete a subnet pool
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent subnet pool.
Returns: None
- subnet_pool – The value can be either the ID of a subnet pool or
a
-
get_subnet_pool
(subnet_pool)¶ Get a single subnet pool
Parameters: subnet_pool – The value can be the ID of a subnet pool or a SubnetPool
instance.Returns: One SubnetPool
Raises: ResourceNotFound
when no resource can be found.
-
find_subnet_pool
(name_or_id, ignore_missing=True)¶ Find a single subnet pool
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
SubnetPool
or None
-
subnet_pools
(**query)¶ Return a generator of subnet pools
Parameters: **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. Available parameters include:
address_scope_id
: Subnet pool address scope IDdescription
: The subnet pool descriptionip_version
: The IP address familyis_default
: Subnet pool is the default (boolean)is_shared
: Subnet pool is shared (boolean)name
: Subnet pool nameproject_id
: Owner tenant ID
Returns: A generator of subnet pool objects Return type: SubnetPool
-
Load Balancer Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_load_balancer
(**attrs)¶ Create a new load balancer from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a LoadBalancer
, comprised of the properties on the LoadBalancer class.Returns: The results of load balancer creation Return type: LoadBalancer
-
update_load_balancer
(load_balancer, **attrs)¶ Update a load balancer
Parameters: - 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
.
Returns: The updated load balancer
Return type: - load_balancer – Either the id of a load balancer or a
-
delete_load_balancer
(load_balancer, ignore_missing=True)¶ Delete a load balancer
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent load balancer.
Returns: None
- load_balancer – The value can be the ID of a load balancer or a
-
get_load_balancer
(load_balancer)¶ Get a single load balancer
Parameters: load_balancer – The value can be the ID of a load balancer or a LoadBalancer
instance.Returns: One LoadBalancer
Raises: ResourceNotFound
when no resource can be found.
-
find_load_balancer
(name_or_id, ignore_missing=True)¶ Find a single load balancer
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
LoadBalancer
or None
-
load_balancers
(**query)¶ Return a generator of load balancers
Parameters: query (dict) – Optional query parameters to be sent to limit the resources being returned. Returns: A generator of load balancer objects Return type: LoadBalancer
-
Health Monitor Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_health_monitor
(**attrs)¶ Create a new health monitor from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a HealthMonitor
, comprised of the properties on the HealthMonitor class.Returns: The results of health monitor creation Return type: HealthMonitor
-
update_health_monitor
(health_monitor, **attrs)¶ Update a health monitor
Parameters: - 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
.
Returns: The updated health monitor
Return type: - health_monitor – Either the id of a health monitor or a
-
delete_health_monitor
(health_monitor, ignore_missing=True)¶ Delete a health monitor
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent health monitor.
Returns: None
- health_monitor – The value can be either the ID of a
health monitor or a
-
get_health_monitor
(health_monitor)¶ Get a single health monitor
Parameters: health_monitor – The value can be the ID of a health monitor or a HealthMonitor
instance.Returns: One HealthMonitor
Raises: ResourceNotFound
when no resource can be found.
-
find_health_monitor
(name_or_id, ignore_missing=True)¶ Find a single health monitor
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
HealthMonitor
or None
-
health_monitors
(**query)¶ Return a generator of health monitors
Parameters: query (dict) – - Optional query parameters to be sent to limit
- 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 health- monitor.
max_retries
: The maximum consecutive health probe attempts.project_id
: The ID of the project this health monitor is- associated with.
timeout
: The maximum number of milliseconds for a monitor to- wait for a connection to be established before it times out.
type
: The type of probe sent by the load balancer for health- check, which can be
PING
,TCP
,HTTP
orHTTPS
.
url_path
: The path portion of a URI that will be probed.
Returns: A generator of health monitor objects Return type: HealthMonitor
-
Metering Label Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_metering_label
(**attrs)¶ Create a new metering label from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a MeteringLabel
, comprised of the properties on the MeteringLabel class.Returns: The results of metering label creation Return type: MeteringLabel
-
update_metering_label
(metering_label, **attrs)¶ Update a metering label
Parameters: - 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
.
Returns: The updated metering label
Return type: - metering_label – Either the id of a metering label or a
-
delete_metering_label
(metering_label, ignore_missing=True)¶ Delete a metering label
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent metering label.
Returns: None
- metering_label – The value can be either the ID of a metering label or a
-
get_metering_label
(metering_label)¶ Get a single metering label
Parameters: metering_label – The value can be the ID of a metering label or a MeteringLabel
instance.Returns: One MeteringLabel
Raises: ResourceNotFound
when no resource can be found.
-
find_metering_label
(name_or_id, ignore_missing=True)¶ Find a single metering label
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
MeteringLabel
or None
-
metering_labels
(**query)¶ Return a generator of metering labels
Parameters: query (dict) – - Optional query parameters to be sent to limit
- 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 is- shared.
project_id
: The ID of the project a metering label is- associated with.
Returns: A generator of metering label objects Return type: MeteringLabel
-
create_metering_label_rule
(**attrs)¶ Create a new metering label rule from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a MeteringLabelRule
, comprised of the properties on the MeteringLabelRule class.Returns: The results of metering label rule creation Return type: MeteringLabelRule
-
update_metering_label_rule
(metering_label_rule, **attrs)¶ Update a metering label rule
Parameters: - 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
.
Returns: The updated metering label rule
Return type: MeteringLabelRule
- metering_label_rule – Either the id of a metering label rule or a
-
delete_metering_label_rule
(metering_label_rule, ignore_missing=True)¶ Delete a metering label rule
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent metering label rule.
Returns: None
- metering_label_rule – The value can be either the ID of a metering label rule
or a
-
get_metering_label_rule
(metering_label_rule)¶ Get a single metering label rule
Parameters: metering_label_rule – The value can be the ID of a metering label rule or a MeteringLabelRule
instance.Returns: One MeteringLabelRule
Raises: ResourceNotFound
when no resource can be found.
-
find_metering_label_rule
(name_or_id, ignore_missing=True)¶ Find a single metering label rule
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
MeteringLabelRule
or None
-
metering_label_rules
(**query)¶ Return a generator of metering label rules
Parameters: query (dict) – - Optional query parameters to be sent to limit
- the resources being returned. Valid parameters are:
direction
: The direction in which metering label rule is- applied.
metering_label_id
: The ID of a metering label this rule is- associated with.
project_id
: The ID of the project the metering label rule is- associated with.
remote_ip_prefix
: The remote IP prefix to be associated with- this metering label rule.
Returns: A generator of metering label rule objects Return type: MeteringLabelRule
-
Segment Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_segment
(**attrs)¶ Create a new segment from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a Segment
, comprised of the properties on the Segment class.Returns: The results of segment creation Return type: Segment
-
update_segment
(segment, **attrs)¶ Update a segment
Parameters: segment – Either the id of a segment or a Segment
instance.Attrs kwargs: The attributes to update on the segment represented by value
.Returns: The update segment Return type: Segment
-
delete_segment
(segment, ignore_missing=True)¶ Delete a segment
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent segment.
Returns: None
- segment – The value can be either the ID of a segment or a
-
get_segment
(segment)¶ Get a single segment
Parameters: segment – The value can be the ID of a segment or a Segment
instance.Returns: One Segment
Raises: ResourceNotFound
when no resource can be found.
-
find_segment
(name_or_id, ignore_missing=True)¶ Find a single segment
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
Segment
or None
-
segments
(**query)¶ Return a generator of segments
Parameters: **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. Available parameters include:
description
: The segment descriptionname
: Name of the segmentsnetwork_id
: ID of the network that owns the segmentsnetwork_type
: Network type for the segmentsphysical_network
: Physical network name for the segmentssegmentation_id
: Segmentation ID for the segments
Returns: A generator of segment objects Return type: Segment
-
Flavor Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_flavor
(**attrs)¶ Create a new network service flavor from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a Flavor
, comprised of the properties on the Flavor class.Returns: The results of flavor creation Return type: Flavor
-
update_flavor
(flavor, **attrs)¶ Update a network service flavor
Parameters: flavor – Either the id of a flavor or a Flavor
instance.Attrs kwargs: The attributes to update on the flavor represented by value
.Returns: The updated flavor Return type: Flavor
-
delete_flavor
(flavor, ignore_missing=True)¶ Delete a network service flavor
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent flavor.
Returns: None
- flavor – The value can be either the ID of a flavor or a
-
get_flavor
(flavor)¶ Get a single network service flavor
Parameters: flavor – The value can be the ID of a flavor or a Flavor
instance.Returns: One Flavor
Raises: ResourceNotFound
when no resource can be found.
-
find_flavor
(name_or_id, ignore_missing=True)¶ Find a single network service flavor
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
Flavor
or None
-
flavors
(**query)¶ Return a generator of network service flavors
Parameters: query (dict) – - Optional query parameters to be sent to limit
- 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.
Returns: A generator of flavor objects Return type: Flavor
-
Service Profile Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_service_profile
(**attrs)¶ Create a new network service flavor profile from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a ServiceProfile
, comprised of the properties on the ServiceProfile class.Returns: The results of service profile creation Return type: ServiceProfile
-
update_service_profile
(service_profile, **attrs)¶ Update a network flavor service profile
Parameters: service_profile – Either the id of a service profile or a ServiceProfile
instance.Attrs kwargs: The attributes to update on the service profile represented by value
.Returns: The updated service profile Return type: ServiceProfile
-
delete_service_profile
(service_profile, ignore_missing=True)¶ Delete a network service flavor profile
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent service profile.
Returns: None
- service_profile – The value can be either the ID of a service
profile or a
-
get_service_profile
(service_profile)¶ Get a single network service flavor profile
Parameters: service_profile – The value can be the ID of a service_profile or a ServiceProfile
instance.Returns: One ServiceProfile
Raises: ResourceNotFound
when no resource can be found.
-
find_service_profile
(name_or_id, ignore_missing=True)¶ Find a single network service flavor profile
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
ServiceProfile
or None
-
service_profiles
(**query)¶ Return a generator of network service flavor profiles
Parameters: query (dict) – - Optional query parameters to be sent to limit the
- resources returned. Available parameters inclue:
description
: The description of the service flavor profiledriver
: Provider driver for the service flavor profileis_enabled
: Whether the profile is enabledproject_id
: The owner project ID
Returns: A generator of service profile objects Return type: ServiceProfile
-
associate_flavor_with_service_profile
(flavor, service_profile)¶ Associate network flavor with service profile.
Parameters: - 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.
Returns: - flavor – Either the id of a flavor or a
-
disassociate_flavor_from_service_profile
(flavor, service_profile)¶ Disassociate network flavor from service profile.
Parameters: - 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.
Returns: - flavor – Either the id of a flavor or a
-
Tag Operations¶
VPN Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
create_vpn_service
(**attrs)¶ Create a new vpn service from attributes
Parameters: attrs (dict) – Keyword arguments which will be used to create a VPNService
, comprised of the properties on the VPNService class.Returns: The results of vpn service creation Return type: VPNService
-
update_vpn_service
(vpn_service, **attrs)¶ Update a vpn service
Parameters: - 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
.
Returns: The updated vpnservice
Return type: VPNService
- vpn_service – Either the id of a vpn service or a
-
delete_vpn_service
(vpn_service, ignore_missing=True)¶ Delete a vpn service
Parameters: - 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 toTrue
, no exception will be set when attempting to delete a nonexistent vpn service.
Returns: None
- vpn_service – The value can be either the ID of a vpn service or a
-
get_vpn_service
(vpn_service)¶ Get a single vpn service
Parameters: vpn_service – The value can be the ID of a vpn service or a VPNService
instance.Returns: One VPNService
Raises: ResourceNotFound
when no resource can be found.
-
find_vpn_service
(name_or_id, ignore_missing=True)¶ Find a single vpn service
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
VPNService
or None
-
vpn_services
(**query)¶ Return a generator of vpn services
Parameters: query (dict) – Optional query parameters to be sent to limit the resources being returned. Returns: A generator of vpn service objects Return type: VPNService
-
Extension Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
find_extension
(name_or_id, ignore_missing=True)¶ Find a single extension
Parameters: - 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 toTrue
, None will be returned when attempting to find a nonexistent resource.
Returns: One
Extension
or None
-
Service Provider Operations¶
-
class
openstack.network.v2._proxy.
Proxy
(session) -
service_providers
(**query)¶ Return a generator of service providers
Parameters: ** query (kwargs) – Optional query parameters to be sent to limit the resources being returned. Returns: A generator of service provider objects Return type: ServiceProvider
-