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.
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 |
Delete an address scope
Parameters: |
|
---|---|
Returns: | None |
Find a single address scope
Parameters: |
|
---|---|
Returns: | One AddressScope or None |
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. |
Return a generator of address scopes
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of address scope objects |
Return type: | AddressScope |
Update an address scope
Parameters: | address_scope – Either the ID of an address scope or a AddressScope instance. |
---|---|
Attrs kwargs: | The attributes to update on the address scope represented by value. |
Returns: | The updated address scope |
Return type: | AddressScope |
Return a generator of network agents
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of agents |
Return type: | Agent |
Delete a network agent
Parameters: |
|
---|---|
Returns: | None |
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. |
Update a network agent
Parameters: | agent – The value can be the ID of a agent or a Agent instance. |
---|---|
Attrs kwargs: | The attributes to update on the agent represented by value. |
Returns: | One Agent |
Return type: | Agent |
Return a generator of availability zones
Returns: | A generator of availability zone objects |
---|---|
Return type: | AvailabilityZone |
Find a single extension
Parameters: |
|
---|---|
Returns: | One Extension or None |
Return a generator of extensions
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of extension objects |
Return type: | Extension |
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 |
Delete a floating ip
Parameters: |
|
---|---|
Returns: | None |
Find an available IP
Returns: | One FloatingIP or None |
---|
Find a single IP
Parameters: |
|
---|---|
Returns: | One FloatingIP or None |
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. |
Return a generator of ips
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of floating IP objects |
Return type: | FloatingIP |
Update a ip
Parameters: | floating_ip – Either the id of a ip or a FloatingIP instance. |
---|---|
Attrs kwargs: | The attributes to update on the ip represented by value. |
Returns: | The updated ip |
Return type: | FloatingIP |
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 |
Delete a health monitor
Parameters: |
|
---|---|
Returns: | None |
Find a single health monitor
Parameters: |
|
---|---|
Returns: | One HealthMonitor or None |
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. |
Return a generator of health monitors
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of health monitor objects |
Return type: | HealthMonitor |
Update a health monitor
Parameters: | health_monitor – Either the id of a health monitor or a HealthMonitor instance. |
---|---|
Attrs kwargs: | The attributes to update on the health monitor represented by value. |
Returns: | The updated health monitor |
Return type: | HealthMonitor |
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 |
Delete a listener
Parameters: |
|
---|---|
Returns: | None |
Find a single listener
Parameters: |
|
---|---|
Returns: | One Listener or None |
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. |
Return a generator of listeners
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of listener objects |
Return type: | Listener |
Update a listener
Parameters: | listener – Either the id of a listener or a Listener instance. |
---|---|
Attrs kwargs: | The attributes to update on the listener represented by value. |
Returns: | The updated listener |
Return type: | Listener |
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 |
Delete a load balancer
Parameters: |
|
---|---|
Returns: | None |
Find a single load balancer
Parameters: |
|
---|---|
Returns: | One LoadBalancer or None |
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. |
Return a generator of load balancers
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of load balancer objects |
Return type: | LoadBalancer |
Update a load balancer
Parameters: | load_balancer – Either the id of a load balancer or a LoadBalancer instance. |
---|---|
Attrs kwargs: | The attributes to update on the load balancer represented by value. |
Returns: | The updated load balancer |
Return type: | LoadBalancer |
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 |
Delete a metering label
Parameters: |
|
---|---|
Returns: | None |
Find a single metering label
Parameters: |
|
---|---|
Returns: | One MeteringLabel or None |
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. |
Return a generator of metering labels
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of metering label objects |
Return type: | MeteringLabel |
Update a metering label
Parameters: | metering_label – Either the id of a metering label or a MeteringLabel instance. |
---|---|
Attrs kwargs: | The attributes to update on the metering label represented by value. |
Returns: | The updated metering label |
Return type: | MeteringLabel |
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 |
Delete a metering label rule
Parameters: |
|
---|---|
Returns: | None |
Find a single metering label rule
Parameters: |
|
---|---|
Returns: | One MeteringLabelRule or None |
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. |
Return a generator of metering label rules
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of metering label rule objects |
Return type: | MeteringLabelRule |
Update a metering label rule
Parameters: | metering_label_rule – Either the id of a metering label rule or a MeteringLabelRule instance. |
---|---|
Attrs kwargs: | The attributes to update on the metering label rule represented by value. |
Returns: | The updated metering label rule |
Return type: | MeteringLabelRule |
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 |
Delete a network
Parameters: |
|
---|---|
Returns: | None |
Find a single network
Parameters: |
|
---|---|
Returns: | One Network or None |
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. |
Return a generator of networks
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of network objects |
Return type: | Network |
Update a network
Parameters: | network – Either the id of a network or a Network instance. |
---|---|
Attrs kwargs: | The attributes to update on the network represented by value. |
Returns: | The updated network |
Return type: | Network |
Find IP availability of a network
Parameters: |
|
---|---|
Returns: | One NetworkIPAvailability or None |
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. |
Return a generator of network ip availabilities
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of network ip availability objects |
Return type: | NetworkIPAvailability |
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 |
Delete a pool
Parameters: |
|
---|---|
Returns: | None |
Find a single pool
Parameters: |
|
---|---|
Returns: | One Pool or None |
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. |
Return a generator of pools
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of pool objects |
Return type: | Pool |
Update a pool
Parameters: | pool – Either the id of a pool or a Pool instance. |
---|---|
Attrs kwargs: | The attributes to update on the pool represented by value. |
Returns: | The updated pool |
Return type: | Pool |
Create a new pool member from attributes
Parameters: |
|
---|---|
Returns: | The results of pool member creation |
Return type: |
Delete a pool member
Parameters: |
|
---|---|
Returns: | None |
Find a single pool member
Parameters: |
|
---|---|
Returns: | One PoolMember or None |
Get a single pool member
Parameters: |
|
---|---|
Returns: | One PoolMember |
Raises: | ResourceNotFound when no resource can be found. |
Return a generator of pool members
Parameters: |
|
---|---|
Returns: | A generator of pool member objects |
Return type: |
Update a pool member
Parameters: |
|
---|---|
Attrs kwargs: | The attributes to update on the pool member represented by value. |
Returns: | The updated pool member |
Return type: |
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 |
Delete a port
Parameters: |
|
---|---|
Returns: | None |
Find a single port
Parameters: |
|
---|---|
Returns: | One Port or None |
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. |
Return a generator of ports
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of port objects |
Return type: | Port |
Update a port
Parameters: | port – Either the id of a port or a Port instance. |
---|---|
Attrs kwargs: | The attributes to update on the port represented by value. |
Returns: | The updated port |
Return type: | Port |
Delete a quota (i.e. reset to the default quota)
Parameters: |
|
---|---|
Returns: | None |
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 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. |
Return a generator of quotas
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of quota objects |
Return type: | Quota |
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 kwargs: | The attributes to update on the quota represented by value. |
Returns: | The updated quota |
Return type: | Quota |
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 |
Delete a RBAC policy
Parameters: |
|
---|---|
Returns: | None |
Find a single RBAC policy
Parameters: |
|
---|---|
Returns: | One RBACPolicy or None |
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. |
Return a generator of RBAC policies
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. Available parameters include:
|
---|---|
Returns: | A generator of rbac objects |
Return type: | RBACPolicy |
Update a RBAC policy
Parameters: | rbac_policy – Either the id of a RBAC policy or a RBACPolicy instance. |
---|---|
Attrs kwargs: | The attributes to update on the RBAC policy represented by value. |
Returns: | The updated RBAC policy |
Return type: | RBACPolicy |
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 |
Delete a router
Parameters: |
|
---|---|
Returns: | None |
Find a single router
Parameters: |
|
---|---|
Returns: | One Router or None |
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. |
Return a generator of routers
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of router objects |
Return type: | Router |
Update a router
Parameters: | router – Either the id of a router or a Router instance. |
---|---|
Attrs kwargs: | The attributes to update on the router represented by value. |
Returns: | The updated router |
Return type: | Router |
Add Interface to a router
Parameters: |
|
||
---|---|---|---|
Returns: | Router with updated interface |
||
Return type: |
|
Remove Interface from a router
Parameters: |
|
||
---|---|---|---|
Returns: | Router with updated interface |
||
Return type: |
|
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 |
Delete a security group
Parameters: |
|
---|---|
Returns: | None |
Find a single security group
Parameters: |
|
---|---|
Returns: | One SecurityGroup or None |
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. |
Return a generator of security groups
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of security group objects |
Return type: | SecurityGroup |
Update a security group
Parameters: | security_group – Either the id of a security group or a SecurityGroup instance. |
---|---|
Attrs kwargs: | The attributes to update on the security group represented by value. |
Returns: | The updated security group |
Return type: | SecurityGroup |
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 a security group rule
Parameters: |
|
---|---|
Returns: | None |
Find a single security group rule
Parameters: |
|
---|---|
Returns: | One SecurityGroupRule or None |
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. |
Return a generator of security group rules
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of security group rule objects |
Return type: | SecurityGroupRule |
Find a single segment
Caution
BETA: This API is a work in progress and is subject to change.
Parameters: |
|
---|---|
Returns: | One Segment or None |
Get a single segment
Caution
BETA: This API is a work in progress and is subject to change.
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. |
Return a generator of segments
Caution
BETA: This API is a work in progress and is subject to change.
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. Available parameters include:
|
---|---|
Returns: | A generator of segment objects |
Return type: | Segment |
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 |
Delete a subnet
Parameters: |
|
---|---|
Returns: | None |
Find a single subnet
Parameters: |
|
---|---|
Returns: | One Subnet or None |
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. |
Return a generator of subnets
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of subnet objects |
Return type: | Subnet |
Update a subnet
Parameters: | subnet – Either the id of a subnet or a Subnet instance. |
---|---|
Attrs kwargs: | The attributes to update on the subnet represented by value. |
Returns: | The updated subnet |
Return type: | Subnet |
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 |
Delete a subnet pool
Parameters: |
|
---|---|
Returns: | None |
Find a single subnet pool
Parameters: |
|
---|---|
Returns: | One SubnetPool or None |
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. |
Return a generator of subnet pools
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of subnet pool objects |
Return type: | SubnetPool |
Update a subnet pool
Parameters: | subnet_pool – Either the ID of a subnet pool or a SubnetPool instance. |
---|---|
Attrs kwargs: | The attributes to update on the subnet pool represented by value. |
Returns: | The updated subnet pool |
Return type: | SubnetPool |
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 |
Delete a vpn service
Parameters: |
|
---|---|
Returns: | None |
Find a single vpn service
Parameters: |
|
---|---|
Returns: | One VPNService or None |
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. |
Return a generator of vpn services
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of vpn service objects |
Return type: | VPNService |
Update a vpn service
Parameters: | vpn_service – Either the id of a vpn service or a VPNService instance. |
---|---|
Attrs kwargs: | The attributes to update on the vpnservice represented by value. |
Returns: | The updated vpnservice |
Return type: | VPNService |
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 |
Delete a QoS policy
Parameters: |
|
---|---|
Returns: | None |
Find a single QoS policy
Parameters: |
|
---|---|
Returns: | One QoSPolicy or None |
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. |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.