Module for handling OpenStack Neutron calls
depends: |
|
---|---|
configuration: | This module is not usable until the user, password, tenant, and auth URL are specified either in a pillar or in the minion's config file. For example: keystone.user: 'admin'
keystone.password: 'password'
keystone.tenant: 'admin'
keystone.auth_url: 'http://127.0.0.1:5000/v2.0/'
keystone.region_name: 'RegionOne'
keystone.service_type: 'network'
If configuration for multiple OpenStack accounts is required, they can be set up as different configuration profiles: For example: openstack1:
keystone.user: 'admin'
keystone.password: 'password'
keystone.tenant: 'admin'
keystone.auth_url: 'http://127.0.0.1:5000/v2.0/'
keystone.region_name: 'RegionOne'
keystone.service_type: 'network'
openstack2:
keystone.user: 'admin'
keystone.password: 'password'
keystone.tenant: 'admin'
keystone.auth_url: 'http://127.0.0.2:5000/v2.0/'
keystone.region_name: 'RegionOne'
keystone.service_type: 'network'
With this configuration in place, any of the neutron functions can make use of a configuration profile by declaring it explicitly. For example: salt '*' neutron.network_list profile=openstack1
|
Adds an external network gateway to the specified router
CLI Example:
salt '*' neutron.add_gateway_router router-name ext-network-name
Parameters: |
|
---|---|
Returns: | Added Gateway router information |
Adds an internal network interface to the specified router
CLI Example:
salt '*' neutron.add_interface_router router-name subnet-name
Parameters: |
|
---|---|
Returns: | Added interface information |
Creates a new floatingIP
CLI Example:
salt '*' neutron.create_floatingip network-name port-name
Parameters: |
|
---|---|
Returns: | Created floatingIP information |
Creates a new IKEPolicy
CLI Example:
salt '*' neutron.create_ikepolicy ikepolicy-name
phase1_negotiation_mode=main auth_algorithm=sha1
encryption_algorithm=aes-128 pfs=group5
Parameters: |
|
---|---|
Returns: | Created IKE policy information |
Creates a new IPsecSiteConnection
CLI Example:
salt '*' neutron.show_ipsec_site_connection connection-name
ipsec-policy-name ikepolicy-name vpnservice-name
192.168.XXX.XXX/24 192.168.XXX.XXX 192.168.XXX.XXX secret
Parameters: |
|
---|---|
Returns: | Created IPSec site connection information |
Creates a new IPsecPolicy
CLI Example:
salt '*' neutron.create_ipsecpolicy ipsecpolicy-name
transform_protocol=esp auth_algorithm=sha1
encapsulation_mode=tunnel encryption_algorithm=aes-128
Parameters: |
|
---|---|
Returns: | Created IPSec policy information |
Creates a new network
CLI Example:
salt '*' neutron.create_network network-name
salt '*' neutron.create_network network-name profile=openstack1
Parameters: |
|
---|---|
Returns: | Created network information |
Creates a new port
CLI Example:
salt '*' neutron.create_port network-name port-name
Parameters: |
|
---|---|
Returns: | Created port information |
Creates a new router
CLI Example:
salt '*' neutron.create_router new-router-name
Parameters: |
|
---|---|
Returns: | Created router information |
Creates a new security group
CLI Example:
salt '*' neutron.create_security_group security-group-name description='Security group for servers'
Parameters: |
|
---|---|
Returns: | Created security group information |
Creates a new security group rule
CLI Example:
salt '*' neutron.show_security_group_rule security-group-rule-id
Parameters: |
|
---|---|
Returns: | Created security group rule information |
Creates a new subnet
CLI Example:
salt '*' neutron.create_subnet network-name 192.168.1.0/24
Parameters: |
|
---|---|
Returns: | Created subnet information |
Creates a new VPN service
CLI Example:
salt '*' neutron.create_vpnservice router-name name
Parameters: |
|
---|---|
Returns: | Created VPN service information |
Deletes the specified floating IP
CLI Example:
salt '*' neutron.delete_floatingip floatingip-id
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Deletes the specified IKEPolicy
CLI Example:
salt '*' neutron.delete_ikepolicy ikepolicy-name
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Deletes the specified IPsecSiteConnection
CLI Example:
salt '*' neutron.delete_ipsec_site_connection connection-name
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Deletes the specified IPsecPolicy
CLI Example:
salt '*' neutron.delete_ipsecpolicy ipsecpolicy-name
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Deletes the specified network
CLI Example:
salt '*' neutron.delete_network network-name
salt '*' neutron.delete_network network-name profile=openstack1
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Deletes the specified port
CLI Example:
salt '*' neutron.delete_network port-name
salt '*' neutron.delete_network port-name profile=openstack1
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Delete the specified tenant's quota value
CLI Example:
salt '*' neutron.update_quota tenant-id
salt '*' neutron.update_quota tenant-id profile=openstack1
Parameters: |
|
---|---|
Returns: | True(Delete succeed) or False(Delete failed) |
Delete the specified router
CLI Example:
salt '*' neutron.delete_router router-name
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Deletes the specified security group
CLI Example:
salt '*' neutron.delete_security_group security-group-name
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Deletes the specified security group rule
CLI Example:
salt '*' neutron.delete_security_group_rule security-group-rule-id
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Deletes the specified subnet
CLI Example:
salt '*' neutron.delete_subnet subnet-name
salt '*' neutron.delete_subnet subnet-name profile=openstack1
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Deletes the specified VPN service
CLI Example:
salt '*' neutron.delete_vpnservice vpnservice-name
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Fetches tenant info in server's context for following quota operation
CLI Example:
salt '*' neutron.get_quotas_tenant
salt '*' neutron.get_quotas_tenant profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | Quotas information |
Fetches a list of all extensions on server side
CLI Example:
salt '*' neutron.list_extensions
salt '*' neutron.list_extensions profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of extensions |
Fetch a list of all floatingIPs for a tenant
CLI Example:
salt '*' neutron.list_floatingips
salt '*' neutron.list_floatingips profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of floatingIP |
Fetches a list of all configured IKEPolicies for a tenant
CLI Example:
salt '*' neutron.list_ikepolicies
salt '*' neutron.list_ikepolicies profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of IKE policy |
Fetches all configured IPsec Site Connections for a tenant
CLI Example:
salt '*' neutron.list_ipsec_site_connections
salt '*' neutron.list_ipsec_site_connections profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of IPSec site connection |
Fetches a list of all configured IPsecPolicies for a tenant
CLI Example:
salt '*' neutron.list_ipsecpolicies ipsecpolicy-name
salt '*' neutron.list_ipsecpolicies ipsecpolicy-name profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of IPSec policy |
Fetches a list of all networks for a tenant
CLI Example:
salt '*' neutron.list_networks
salt '*' neutron.list_networks profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of network |
Fetches a list of all networks for a tenant
CLI Example:
salt '*' neutron.list_ports
salt '*' neutron.list_ports profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of port |
Fetches all tenants quotas
CLI Example:
salt '*' neutron.list_quotas
salt '*' neutron.list_quotas profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of quotas |
Fetches a list of all routers for a tenant
CLI Example:
salt '*' neutron.list_routers
salt '*' neutron.list_routers profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of router |
Fetches a list of all security group rules for a tenant
CLI Example:
salt '*' neutron.list_security_group_rules
salt '*' neutron.list_security_group_rules profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of security group rule |
Fetches a list of all security groups for a tenant
CLI Example:
salt '*' neutron.list_security_groups
salt '*' neutron.list_security_groups profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of security group |
Fetches a list of all networks for a tenant
CLI Example:
salt '*' neutron.list_subnets
salt '*' neutron.list_subnets profile=openstack1
Parameters: | profile -- Profile to build on (Optional) |
---|---|
Returns: | List of subnet |
Fetches a list of all configured VPN services for a tenant
CLI Example:
salt '*' neutron.list_vpnservices
Parameters: |
|
---|---|
Returns: | List of VPN service |
Removes an external network gateway from the specified router
CLI Example:
salt '*' neutron.remove_gateway_router router-name
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Removes an internal network interface from the specified router
CLI Example:
salt '*' neutron.remove_interface_router router-name subnet-name
Parameters: |
|
---|---|
Returns: | True(Succeed) or False |
Fetches information of a certain floatingIP
CLI Example:
salt '*' neutron.show_floatingip floatingip-id
Parameters: |
|
---|---|
Returns: | Floating IP information |
Fetches information of a specific IKEPolicy
CLI Example:
salt '*' neutron.show_ikepolicy ikepolicy-name
Parameters: |
|
---|---|
Returns: | IKE policy information |
Fetches information of a specific IPsecSiteConnection
CLI Example:
salt '*' neutron.show_ipsec_site_connection connection-name
Parameters: |
|
---|---|
Returns: | IPSec site connection information |
Fetches information of a specific IPsecPolicy
CLI Example:
salt '*' neutron.show_ipsecpolicy ipsecpolicy-name
Parameters: |
|
---|---|
Returns: | IPSec policy information |
Fetches information of a certain network
CLI Example:
salt '*' neutron.show_network network-name
salt '*' neutron.show_network network-name profile=openstack1
Parameters: |
|
---|---|
Returns: | Network information |
Fetches information of a certain port
CLI Example:
salt '*' neutron.show_port port-id
salt '*' neutron.show_port port-id profile=openstack1
Parameters: |
|
---|---|
Returns: | Port information |
Fetches information of a certain tenant's quotas
CLI Example:
salt '*' neutron.show_quota tenant-id
salt '*' neutron.show_quota tenant-id profile=openstack1
Parameters: |
|
---|---|
Returns: | Quota information |
Fetches information of a certain router
CLI Example:
salt '*' neutron.show_router router-name
Parameters: |
|
---|---|
Returns: | Router information |
Fetches information of a certain security group
CLI Example:
salt '*' neutron.show_security_group security-group-name
Parameters: |
|
---|---|
Returns: | Security group information |
Fetches information of a certain security group rule
CLI Example:
salt '*' neutron.show_security_group_rule security-group-rule-id
Parameters: |
|
---|---|
Returns: | Security group rule information |
Fetches information of a certain subnet
CLI Example:
salt '*' neutron.show_subnet subnet-name
Parameters: |
|
---|---|
Returns: | Subnet information |
Fetches information of a specific VPN service
CLI Example:
salt '*' neutron.show_vpnservice vpnservice-name
Parameters: |
|
---|---|
Returns: | VPN service information |
Updates a floatingIP
CLI Example:
salt '*' neutron.update_floatingip network-name port-name
Parameters: |
|
---|---|
Returns: | Value of updated floating IP information |
Updates a network
CLI Example:
salt '*' neutron.update_network network-name new-network-name
Parameters: |
|
---|---|
Returns: | Value of updated network information |
Updates a port
CLI Example:
salt '*' neutron.update_port port-name network-name new-port-name
Parameters: |
|
---|---|
Returns: | Value of updated port information |
Update a tenant's quota
CLI Example:
salt '*' neutron.update_quota tenant-id subnet=40 router=50
network=10 floatingip=30 port=30
Parameters: |
|
---|---|
Returns: | Value of updated quota |
Updates a router
CLI Example:
salt '*' neutron.update_router router_id name=new-router-name
admin_state_up=True
Parameters: |
|
---|---|
Returns: | Value of updated router information |
Updates a security group
CLI Example:
salt '*' neutron.update_security_group security-group-name new-security-group-name
Parameters: |
|
---|---|
Returns: | Value of updated security group information |
Updates a subnet
CLI Example:
salt '*' neutron.update_subnet subnet-name new-subnet-name
Parameters: |
|
---|---|
Returns: | Value of updated subnet information |
Updates a VPN service
CLI Example:
salt '*' neutron.update_vpnservice vpnservice-name desc='VPN Service1'
Parameters: |
|
---|---|
Returns: | Value of updated VPN service information |
Docs for previous releases are available on readthedocs.org.
Latest Salt release: 2014.7.2
22.16.144. salt.modules.network