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.
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 a DHCP Agent to a network
agent – Either the agent id of an instance of
Agent
network – Network instance
Remove a DHCP Agent from a network
agent – Either the agent id of an instance of
Agent
network – Network instance
Create a new network from attributes
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Network
or None
Get a single network
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 for
the network.
ipv6_address_scope_id
: The ID of the IPv6 address scope for
the 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 Tunnel
ID for GENEVE/GRE/VXLAN networks
A generator of network objects
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 – The attributes to update on the network represented
by network
.
The updated network
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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
NetworkIPAvailability
or None
Get IP availability of a network
network – The value can be the ID of a network or a
Network
instance.
ResourceNotFound
when no resource can be found.
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 IP
availability.
network_name
: The name of the network for the particular
network IP availability.
project_id
: Owner tenant ID
A generator of network ip availability objects
Create a new port from attributes
Create ports from the list of attributes
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Port
or None
Get a single port
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 a port
Create a new router from attributes
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Router
or None
Get a single router
Return a generator of routers
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 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 associated
with.
status
: The status of the router.
A generator of router objects
Update a router
Add Interface to a router
Remove Interface from a router
Add extra routes to a router
Remove extra routes from a router
Add Gateway to a router
Remove Gateway from a router
Create a new L3 conntrack helper from attributes
router – Either the router ID or an instance of
Router
attrs – Keyword arguments which will be used to create a
ConntrackHelper
,
comprised of the properties on the ConntrackHelper class.
The results of conntrack helper creation
ConntrackHelper
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
ConntrackHelper
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 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.
attrs – The attributes to update on the L3 conntrack helper
represented by conntrack_helper
.
The updated conntrack helper
ConntrackHelper
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
Create a new floating ip from attributes
attrs – 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 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 an available IP
One FloatingIP
or None
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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One FloatingIP
or None
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.
Return a generator of ips
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 be ACTIVE
or DOWN
.
A generator of floating IP objects
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 – The attributes to update on the ip represented
by value
.
The updated ip
Create a new pool from attributes
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Pool
or None
Get a single pool
Return a generator of pools
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 of
TCP
, HTTP
or HTTPS
.
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.
A generator of pool objects
Update a pool
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 – 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 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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One PoolMember
or None
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.
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) –
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.
A generator of pool member objects
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 – The attributes to update on the pool member
represented by pool_member
.
The updated pool member
Get the auto-allocated topology of a given tenant
project – The value is the ID or name of a project
The auto-allocated topology
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 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
Create a new security group from attributes
attrs – 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 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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
SecurityGroup
or None
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.
Return a generator of security groups
query (dict) –
Optional query parameters to be sent to limit 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 is
associated with.
A generator of security group objects
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 – The attributes to update on the security group
represented by security_group
.
The updated security group
Create a new security group rule from attributes
attrs – 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
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
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
SecurityGroupRule
or None
Get a single security group rule
security_group_rule – The value can be the ID of a security group rule or a
SecurityGroupRule
instance.
ResourceNotFound
when no resource can be found.
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 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 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
Create a new address group from attributes
attrs – Keyword arguments which will be used to create
a AddressGroup
,
comprised of the properties on the AddressGroup class.
The results of address group creation
Delete an address group
address_group – The value can be either the ID of an
address group or
a AddressGroup
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will
be raised when the address group does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent address group.
None
Find a single address group
name_or_id – The name or ID of an address 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One AddressGroup
or None
Get a single address group
address_group – The value can be the ID of an address group or a
AddressGroup
instance.
One AddressGroup
ResourceNotFound
when no resource can be found.
Return a generator of address groups
query (dict) –
Optional query parameters to be sent to limit the resources being returned.
name
: Address group name
description
: Address group description
project_id
: Owner project ID
A generator of address group objects
Update an address group
address_group – Either the ID of an address group or a
AddressGroup
instance.
attrs – The attributes to update on the address group
represented by value
.
The updated address group
Add addresses to a address group
address_group – Either the ID of an address group or a
AddressGroup
instance.
addresses (list) – List of address strings.
AddressGroup with updated addresses
Remove addresses from a address group
address_group – Either the ID of an address group or a
AddressGroup
instance.
addresses (list) – List of address strings.
AddressGroup with updated addresses
Return a generator of availability zones
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.
A generator of availability zone objects
Create a new address scope from attributes
attrs – 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 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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One AddressScope
or None
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.
Return a generator of address scopes
query (dict) –
Optional query parameters to be sent to limit 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 an address scope
address_scope – Either the ID of an address scope or a
AddressScope
instance.
attrs – The attributes to update on the address scope
represented by value
.
The updated address scope
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 a 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.
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
Create a new bandwidth limit rule
attrs – 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
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
QoSBandwidthLimitRule
or None
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.
ResourceNotFound
when no resource can be found.
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
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.
attrs – The attributes to update on the bandwidth limit rule
represented by qos_rule
.
The updated minimum bandwidth rule
Create a new QoS DSCP marking rule
attrs – 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
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
QoSDSCPMarkingRule
or None
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.
ResourceNotFound
when no resource can be found.
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
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.
attrs – The attributes to update on the QoS DSCP marking rule
represented by qos_rule
.
The updated QoS DSCP marking rule
Create a new minimum bandwidth rule
attrs – 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
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
QoSMinimumBandwidthRule
or None
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.
ResourceNotFound
when no resource can be found.
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
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.
attrs – The attributes to update on the minimum bandwidth rule
represented by qos_rule
.
The updated minimum bandwidth rule
Create a new minimum packet rate rule
attrs – Keyword arguments which will be used to create a
QoSMinimumPacketRateRule
,
comprised of the properties on the QoSMinimumPacketRateRule 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
Delete a minimum packet rate rule
qos_rule – The value can be either the ID of a minimum packet
rate rule or a
QoSMinimumPacketRateRule
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 packet
rate rule.
None
Find a minimum packet rate rule
qos_rule_id – The ID of a minimum packet rate 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
QoSMinimumPacketRateRule
or None
Get a single minimum packet rate rule
qos_rule – The value can be the ID of a minimum packet rate rule
or a
QoSMinimumPacketRateRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a
QoSPolicy
instance.
ResourceNotFound
when no
resource can be found.
Return a generator of minimum packet rate 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 packet rate rule objects
Update a minimum packet rate rule
qos_rule – Either the id of a minimum packet rate rule or a
QoSMinimumPacketRateRule
instance.
qos_policy – The value can be the ID of the QoS policy that the
rule belongs or a
QoSPolicy
instance.
attrs – The attributes to update on the minimum packet rate rule
represented by qos_rule
.
The updated minimum packet rate rule
Create a new QoS policy from attributes
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One QoSPolicy
or
None
Get a single QoS policy
Return a generator of QoS policies
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.
A generator of QoS policy objects
Update a QoS policy
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 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.
Return a generator of QoS rule types
query (dict) –
Optional query parameters to be sent to limit the resources returned. Valid parameters include:
type
: The type of the QoS rule type.
A generator of QoS rule type objects
Return a generator of network agents
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.
A generator of agents
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 a single network agent
Update a network agent
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
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
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 L3 agent
Create a new RBAC policy from attributes
attrs – 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 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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
RBACPolicy
or None
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.
Return a generator of RBAC policies
query (dict) –
Optional query parameters to be sent to limit 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 policy
affects
project_id
: Owner tenant ID
A generator of rbac objects
Update a RBAC policy
rbac_policy – Either the id of a RBAC policy or a
RBACPolicy
instance.
attrs – The attributes to update on the RBAC policy
represented by rbac_policy
.
The updated RBAC policy
Create a new listener from attributes
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Listener
or None
Get a single listener
Return a generator of listeners
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.
A generator of listener objects
Create a new subnet from attributes
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Subnet
or None
Get a single subnet
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 a
CIDR.
A generator of subnet objects
Update a subnet
Create a new subnet pool from attributes
attrs – 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 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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One SubnetPool
or None
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.
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 a subnet pool
subnet_pool – Either the ID of a subnet pool or a
SubnetPool
instance.
attrs – The attributes to update on the subnet pool
represented by subnet_pool
.
The updated subnet pool
Create a new load balancer from attributes
attrs – 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 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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One LoadBalancer
or None
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.
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 a load balancer
load_balancer – Either the id of a load balancer or a
LoadBalancer
instance.
attrs – The attributes to update on the load balancer
represented by load_balancer
.
The updated load balancer
Create a new health monitor from attributes
attrs – 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 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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
HealthMonitor
or None
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.
Return a generator of health monitors
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
or
HTTPS
.
url_path
: The path portion of a URI that will be probed.
A generator of health monitor objects
Update a health monitor
health_monitor – Either the id of a health monitor or a
HealthMonitor
instance.
attrs – The attributes to update on the health monitor
represented by value
.
The updated health monitor
Create a new metering label from attributes
attrs – 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 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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
MeteringLabel
or None
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.
Return a generator of metering labels
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.
A generator of metering label objects
Update a metering label
metering_label – Either the id of a metering label or a
MeteringLabel
instance.
attrs – The attributes to update on the metering label
represented by metering_label
.
The updated metering label
Create a new metering label rule from attributes
attrs – 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
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
MeteringLabelRule
or None
Get a single metering label rule
metering_label_rule – The value can be the ID of a metering label rule or a
MeteringLabelRule
instance.
ResourceNotFound
when no resource can be found.
Return a generator of metering label rules
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.
A generator of metering label rule objects
Update a metering label rule
metering_label_rule – Either the id of a metering label rule or a
MeteringLabelRule
instance.
attrs – The attributes to update on the metering label rule
represented by metering_label_rule
.
The updated metering label rule
Create a new segment from attributes
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Segment
or None
Get a single segment
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
Create a new network service flavor from attributes
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Flavor
or None
Get a single network service flavor
Update a network service flavor
Return a generator of network service flavors
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.
A generator of flavor objects
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 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 a new network service flavor profile from attributes
attrs – 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 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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
ServiceProfile
or None
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.
Return a generator of network service flavor profiles
query (dict) –
Optional query parameters to be sent to limit the 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 a network flavor service profile
service_profile – Either the id of a service profile or a
ServiceProfile
instance.
attrs – The attributes to update on the service profile
represented by service_profile
.
The updated service profile
Create a new vpn endpoint group from attributes
attrs – Keyword arguments which will be used to create a
VpnEndpointGroup
,
comprised of the properties on the VpnEndpointGroup class.
The results of vpn endpoint group creation.
Delete a vpn service
vpn_endpoint_group – The value can be either the ID of a vpn service or a
VpnEndpointGroup
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
VpnEndpointGroup
or None
Get a single vpn service
vpn_endpoint_group – The value can be the ID of a vpn service
or a
VpnEndpointGroup
instance.
One
VpnEndpointGroup
ResourceNotFound
when no resource can be found.
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
Update a vpn service
vpn_endpoint_group – Either the id of a vpn service or a
VpnEndpointGroup
instance.
attrs – The attributes to update on the VPN service
represented by vpn_endpoint_group
.
The updated vpnservice
Create a new IPsec site connection from attributes
attrs – Keyword arguments which will be used to create a
VpnIPSecSiteConnection
,
comprised of the properties on the IPSecSiteConnection class.
The results of IPsec site connection creation
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.
query (dict) – Any additional parameters to be passed into underlying methods such as query filters.
One
VpnIPSecSiteConnection
or None
Get a single IPsec site connection
ipsec_site_connection – The value can be the ID of an IPsec site
connection or a
VpnIPSecSiteConnection
instance.
ResourceNotFound
when no resource can be found.
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
Update a IPsec site connection
Either the id of an IPsec site connection or
a
VpnIPSecSiteConnection
instance.
attrs – The attributes to update on the IPsec site
connection represented by ipsec_site_connection
.
The updated IPsec site connection
Delete a IPsec site connection
ipsec_site_connection – The value can be either the ID of an
IPsec site connection, or a
VpnIPSecSiteConnection
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
Create a new ike policy from attributes
attrs – Keyword arguments which will be used to create a
VpnIkePolicy
,
comprised of the properties on the VpnIkePolicy class.
The results of ike policy creation :rtype:
VpnIkePolicy
Find a single ike policy
name_or_id – The name or ID of an IKE 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.
query (dict) – Any additional parameters to be passed into underlying methods such as query filters.
One
VpnIkePolicy
or None.
Get a single ike policy
ike_policy – The value can be the ID of an IKE policy or a
VpnIkePolicy
instance.
One
VpnIkePolicy
VpnIkePolicy
ResourceNotFound
when no
resource can be found.
Return a generator of IKE policies
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of ike policy objects
Update an IKE policy
Either the IK of an IKE policy or a
VpnIkePolicy
instance.
attrs – The attributes to update on the ike policy
represented by ike_policy
.
The updated ike policy
Delete an IKE policy
ike_policy – The value can be either the ID of an ike policy, or
a VpnIkePolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised when the ike policy does not exist.
When set to True
, no exception will be set when attempting to
delete a nonexistent ike policy.
None
Create a new IPsec policy from attributes
attrs – Keyword arguments which will be used to create a
VpnIpsecPolicy
,
comprised of the properties on the VpnIpsecPolicy class.
The results of IPsec policy creation :rtype:
VpnIpsecPolicy
Find a single IPsec policy
name_or_id – The name or ID of an IPsec 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.
query (dict) – Any additional parameters to be passed into underlying methods such as query filters.
One
VpnIpsecPolicy
or None.
Get a single IPsec policy
ipsec_policy – The value can be the ID of an IPcec policy or a
VpnIpsecPolicy
instance.
One
VpnIpsecPolicy
VpnIpsecPolicy
ResourceNotFound
when no
resource can be found.
Return a generator of IPsec policies
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of IPsec policy objects
Update an IPsec policy
Either the id of an IPsec policy or a
VpnIpsecPolicy
instance.
attrs – The attributes to update on the IPsec policy
represented by ipsec_policy
.
The updated IPsec policy
Delete an IPsec policy
ipsec_policy – The value can be either the ID of an IPsec policy,
or a
VpnIpsecPolicy
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be raised when the IPsec policy does not exist. When set to
True
, no exception will be set when attempting to delete a
nonexistent IPsec policy.
None
Create a new vpn service from attributes
attrs – Keyword arguments which will be used to create
a VpnService
,
comprised of the properties on the VpnService class.
The results of vpn service creation
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 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One VpnService
or None
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.
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
Update a vpn service
vpn_service – Either the id of a vpn service or a
VpnService
instance.
attrs – The attributes to update on the VPN service
represented by vpn_service
.
The updated vpnservice
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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One Extension
or None
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
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
Create a new local ip from attributes
Delete a local ip
local_ip – The value can be either the ID of a local ip or a
LocalIP
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the local 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 a local IP
name_or_id – The name or ID of an local 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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One LocalIP
or None
Get a single local ip
Return a generator of local ips
query (dict) –
Optional query parameters to be sent to limit the resources being returned.
name
: Local IP name
description
: Local IP description
project_id
: Owner project ID
network_id
: Local IP network
local_port_id
: Local port ID
local_ip_address
: The IP address of a Local IP
ip_mode
: The Local IP mode
A generator of local ip objects
Update a local ip
Create a new local ip association from attributes
local_ip – The value can be the ID of a Local IP or a
LocalIP
instance.
attrs – Keyword arguments which will be used to create
a
LocalIPAssociation
,
comprised of the properties on the LocalIP class.
The results of local ip association creation
Delete a local ip association
local_ip – The value can be the ID of a Local IP or a
LocalIP
instance.
fixed_port_id – The value can be either the fixed port ID or a :class: ~openstack.network.v2.local_ip_association.LocalIPAssociation instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the local ip association 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 a local ip association
name_or_id – The name or ID of local ip association.
local_ip – The value can be the ID of a Local IP or a
LocalIP
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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One
LocalIPAssociation
or None
Get a single local ip association
local_ip – The value can be the ID of a Local IP or a
LocalIP
instance.
local_ip_association – The value can be the ID
of a local ip association or a
LocalIPAssociation
instance.
ResourceNotFound
when no resource can be found.
Return a generator of local ip associations
local_ip – The value can be the ID of a Local IP or a
LocalIP
instance.
query (dict) –
Optional query parameters to be sent to limit the resources being returned.
fixed_port_id
: The ID of the port to which a local IP
is associated
fixed_ip
: The fixed ip address associated with a
a Local IP
host
: Host where local ip is associated
A generator of local ip association objects
Create a new ndp proxy from attributes
attrs – Keyword arguments which will be used to create
a NDPProxxy
,
comprised of the properties on the NDPProxy class.
The results of ndp proxy creation
NDPProxxy
Get a single ndp proxy
Find a single ndp proxy
ndp_proxy_id – The ID of a ndp proxy.
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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One NDPProxy
or None
Delete a ndp proxy
ndp_proxy – The value can be the ID of a ndp proxy
or a NDPProxy
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 ndp proxy.
None
Return a generator of ndp proxies
query (dict) –
Optional query parameters to be sent to limit the resources being returned. Valid parameters are:
router_id
: The ID fo the router
port_id
: The ID of internal port.
ip_address
: The internal IP address
A generator of port forwarding objects
PortForwarding
Create a new BGP Peer from attributes
Delete a BGP Peer
Find a single BGP Peer
Get a signle BGP Peer
Update a BGP Peer
Return a generator of BGP Peers
Create a new BGP Speaker
Delete a BGP Speaker
Find a single BGP Peer
Get a signle BGP Speaker
Update a BGP Speaker
Return a generator of BGP Peers
Bind the BGP peer to the specified BGP Speaker.
Unbind the BGP peer from a BGP Speaker.
Add a network to the specified BGP speaker.
Remove a network from the specified BGP speaker.
List all routes advertised by the specified BGP Speaker.
List all BGP dynamic agents which are hosting the specified BGP Speaker.
Add a BGP Speaker to the specified dynamic routing agent.
List all BGP Seakers hosted on the specified dynamic routing agent.
Delete the BGP Speaker hosted by the specified dynamic routing agent.
Create a new Tap Flow from attributes
Delete a Tap Flow
Find a single Tap Service
Get a signle Tap Flow
Update a Tap Flow
Return a generator of Tap Flows
Create a new Tap Service from attributes
Delete a Tap Service
Find a single Tap Service
Update a Tap Service
Return a generator of Tap Services
Create a new BGPVPN
Delete a BGPVPN
bgpvpn – The value can be either the ID of a bgpvpn or
a BgpVpn
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the BGPVPN does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent BGPVPN.
None
Find a single BGPVPN
name_or_id – The name or ID of a BGPVPN.
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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One BGPVPN
or None
Get a signle BGPVPN
Update a BGPVPN
Return a generator of BGP VPNs
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of BgpVPN objects
Create a new BGPVPN Network Association
bgpvpn – The value can be either the ID of a bgpvpn or
a BgpVpn
instance.
attrs – Keyword arguments which will be used to create
a
BgpVpnNetworkAssociation
,
comprised of the properties on the BgpVpnNetworkAssociation class.
The results of BgpVpnNetworkAssociation creation
BgpVpnNetworkAssociation
Delete a BGPVPN Network Association
bgpvpn – The value can be either the ID of a bgpvpn or
a BgpVpn
instance.
net_association – The value can be either the ID of a
bgpvpn_network_association or
a
BgpVpnNetworkAssociation
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the BgpVpnNetworkAssociation does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent BgpVpnNetworkAssociation.
None
Get a signle BGPVPN Network Association
bgpvpn – The value can be the ID of a BGPVPN or a
BgpVpn
instance.
net_association – The value can be the ID of a
BgpVpnNetworkAssociation or a
BgpVpnNetworkAssociation
instance.
One BgpVpnNetworkAssociation
ResourceNotFound
when no resource can be found.
Return a generator of BGP VPN Network Associations
bgpvpn: The value can be the ID of a BGPVPN or a
BgpVpn
instance.
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of BgpVpnNetworkAssociation objects
BgpVpnNetworkAssociation
Create a new BGPVPN Port Association
bgpvpn – The value can be either the ID of a bgpvpn or
a BgpVpn
instance.
attrs – Keyword arguments which will be used to create
a
BgpVpnPortAssociation
,
comprised of the properties on the BgpVpnPortAssociation class.
The results of BgpVpnPortAssociation creation
BgpVpnPortAssociation
Delete a BGPVPN Port Association
bgpvpn – The value can be either the ID of a bgpvpn or
a BgpVpn
instance.
port_association – The value can be either the ID of a
bgpvpn_port_association or
a
BgpVpnPortAssociation
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the BgpVpnPortAssociation does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent BgpVpnPortAssociation.
None
Find a single BGPVPN Port Association
name_or_id – The name or ID of a BgpVpnNetworkAssociation.
bgpvpn_id – The value can be the ID of a BGPVPN.
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.
query (dict) – Any additional parameters to be passed into underlying methods. such as query filters.
One BGPVPN
or None
Get a signle BGPVPN Port Association
bgpvpn – The value can be the ID of a BGPVPN or a
BgpVpn
instance.
port_association – The value can be the ID of a
BgpVpnPortAssociation or a
BgpVpnPortAssociation
instance.
One BgpVpnPortAssociation
ResourceNotFound
when no resource can be found.
Update a BPGPN Port Association
bgpvpn – Either the ID of a BGPVPN or a
BgpVpn
instance.
port_association – The value can be the ID of a
BgpVpnPortAssociation or a
BgpVpnPortAssociation
instance.
attrs – The attributes to update on the BGPVPN represented
by value
.
The updated BgpVpnPortAssociation.
Return a generator of BGP VPN Port Associations
bgpvpn: The value can be the ID of a BGPVPN or a
BgpVpn
instance.
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of BgpVpnNetworkAssociation objects
BgpVpnNetworkAssociation
Create a new BGPVPN Router Association
bgpvpn – The value can be either the ID of a bgpvpn or
a BgpVpn
instance.
attrs – Keyword arguments which will be used to create
a
BgpVpnRouterAssociation
,
comprised of the properties on the BgpVpnRouterAssociation class.
The results of BgpVpnRouterAssociation creation
BgpVpnRouterAssociation
Delete a BGPVPN Router Association
bgpvpn – The value can be either the ID of a bgpvpn or
a BgpVpn
instance.
port_association – The value can be either the ID of a
bgpvpn_router_association or
a
BgpVpnRouterAssociation
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the BgpVpnRouterAssociation does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent BgpVpnRouterAsociation.
None
Get a signle BGPVPN Router Association
bgpvpn – The value can be the ID of a BGPVPN or a
BgpVpn
instance.
router_association – The value can be the ID of a
BgpVpnRouterAssociation or a
BgpVpnRouterAssociation
instance.
One BgpVpnRouterAssociation
ResourceNotFound
when no resource can be found.
Update a BPGPN Router Association
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of BgpVpnNetworkAssociation objects
BgpVpnNetworkAssociation
Return a generator of BGP VPN router Associations
bgpvpn: The value can be the ID of a BGPVPN or a
BgpVpn
instance.
query (dict) – Optional query parameters to be sent to limit the resources being returned.
A generator of BgpVpnRouterAssociation objects
BgpVpnRouterAssociation
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.