Neutron module for interacting with OpenStack Neutron
New in version 2018.3.0.
:depends:shade
Example configuration
neutron:
cloud: default
neutron:
auth:
username: admin
password: password123
user_domain_name: mydomain
project_name: myproject
project_domain_name: myproject
auth_url: https://example.org:5000/v3
identity_api_version: 3
salt.modules.neutronng.
compare_changes
(obj, **kwargs)¶Compare two dicts returning only keys that exist in the first dict and are different in the second one
salt.modules.neutronng.
get_openstack_cloud
(auth=None)¶Return an openstack_cloud
salt.modules.neutronng.
get_operator_cloud
(auth=None)¶Return an operator_cloud
salt.modules.neutronng.
list_networks
(auth=None, **kwargs)¶List networks
CLI Example:
salt '*' neutronng.list_networks
salt '*' neutronng.list_networks filters='{"tenant_id": "1dcac318a83b4610b7a7f7ba01465548"}'
salt.modules.neutronng.
list_subnets
(auth=None, **kwargs)¶List subnets
CLI Example:
salt '*' neutronng.list_subnets
salt '*' neutronng.list_subnets filters='{"tenant_id": "1dcac318a83b4610b7a7f7ba01465548"}'
salt.modules.neutronng.
network_create
(auth=None, **kwargs)¶Create a network
True
, set the network as sharedTrue
, Set the network administrative state to "up"CLI Example:
salt '*' neutronng.network_create name=network2 shared=True admin_state_up=True external=True
salt '*' neutronng.network_create name=network3 provider='{"network_type": "vlan", "segmentation_id": "4010", "physical_network": "provider"}' project_id=1dcac318a83b4610b7a7f7ba01465548
salt.modules.neutronng.
network_delete
(auth=None, **kwargs)¶Delete a network
CLI Example:
salt '*' neutronng.network_delete name_or_id=network1
salt '*' neutronng.network_delete name_or_id=1dcac318a83b4610b7a7f7ba01465548
salt.modules.neutronng.
network_get
(auth=None, **kwargs)¶Get a single network
CLI Example:
salt '*' neutronng.network_get name=XLB4
salt.modules.neutronng.
security_group_create
(auth=None, **kwargs)¶Create a security group. Use security_group_get to create default.
CLI Example:
salt '*' neutronng.security_group_create name=secgroup1 description="Very secure security group"
salt '*' neutronng.security_group_create name=secgroup1 description="Very secure security group" project_id=1dcac318a83b4610b7a7f7ba01465548
salt.modules.neutronng.
security_group_delete
(auth=None, **kwargs)¶Delete a security group
CLI Example:
salt '*' neutronng.security_group_delete name_or_id=secgroup1
salt.modules.neutronng.
security_group_get
(auth=None, **kwargs)¶Get a single security group. This will create a default security group if one does not exist yet for a particular project id.
CLI Example:
salt '*' neutronng.security_group_get name=1dcac318a83b4610b7a7f7ba01465548
salt '*' neutronng.security_group_get name=default filters='{"tenant_id":"2e778bb64ca64a199eb526b5958d8710"}'
salt.modules.neutronng.
security_group_rule_create
(auth=None, **kwargs)¶Create a rule in a security group
None
, tcp
, udp
, and icmp
.ingress
or egress
; the direction in which the security
group rule is applied. For a compute instance, an ingress security
group rule is applied to incoming (ingress) traffic for that instance.
An egress rule is applied to traffic leaving the instanceCLI Example:
salt '*' neutronng.security_group_rule_create secgroup_name_or_id=secgroup1
salt '*' neutronng.security_group_rule_create secgroup_name_or_id=secgroup2 port_range_min=8080 port_range_max=8080 direction='egress'
salt '*' neutronng.security_group_rule_create secgroup_name_or_id=c0e1d1ce-7296-405e-919d-1c08217be529 protocol=icmp project_id=1dcac318a83b4610b7a7f7ba01465548
salt.modules.neutronng.
security_group_rule_delete
(auth=None, **kwargs)¶Delete a security group
CLI Example:
salt '*' neutronng.security_group_rule_delete name_or_id=1dcac318a83b4610b7a7f7ba01465548
salt.modules.neutronng.
security_group_update
(secgroup=None, auth=None, **kwargs)¶Update a security group
CLI Example:
salt '*' neutronng.security_group_update secgroup=secgroup1 description="Very secure security group"
salt '*' neutronng.security_group_update secgroup=secgroup1 description="Very secure security group" project_id=1dcac318a83b4610b7a7f7ba01465548
salt.modules.neutronng.
setup_clouds
(auth=None)¶Call functions to create Shade cloud objects in __context__ to take advantage of Shade's in-memory caching across several states
salt.modules.neutronng.
subnet_create
(auth=None, **kwargs)¶Create a subnet
True
if DHCP is enabled and False
if disabledallocation_pools
and
gateway_ip
, you must ensure that the gateway IP does not overlap
with the specified allocation pools.True
if gateway IP address is disabled and False
if
enabled. It is not allowed with gateway_ip
.dhcpv6-stateful
,
dhcpv6-stateless
, or slaac
.dhcpv6-stateful
,
dhcpv6-stateless
, or slaac
.True
, use the default subnetpool for ip_version
to obtain a
CIDR. It is required to pass None
to the cidr
argument when
enabling this option.CLI Example:
salt '*' neutronng.subnet_create network_name_or_id=network1
subnet_name=subnet1
salt '*' neutronng.subnet_create subnet_name=subnet2 network_name_or_id=network2 enable_dhcp=True allocation_pools='[{"start": "192.168.199.2", "end": "192.168.199.254"}]' gateway_ip='192.168.199.1' cidr=192.168.199.0/24
salt '*' neutronng.subnet_create network_name_or_id=network1 subnet_name=subnet1 dns_nameservers='["8.8.8.8", "8.8.8.7"]'
salt.modules.neutronng.
subnet_delete
(auth=None, **kwargs)¶Delete a subnet
CLI Example:
salt '*' neutronng.subnet_delete name=subnet1
salt '*' neutronng.subnet_delete name=1dcac318a83b4610b7a7f7ba01465548
salt.modules.neutronng.
subnet_get
(auth=None, **kwargs)¶Get a single subnet
CLI Example:
salt '*' neutronng.subnet_get name=subnet1
salt.modules.neutronng.
subnet_update
(auth=None, **kwargs)¶Update a subnet
True
if DHCP is enabled and False
if disabledTrue
if gateway IP address is disabled and False if enabled.
It is not allowed with gateway_ip
.salt '*' neutronng.subnet_update name=subnet1 subnet_name=subnet2
salt '*' neutronng.subnet_update name=subnet1 dns_nameservers='["8.8.8.8", "8.8.8.7"]'
Docs for previous releases are available on readthedocs.org.
Latest Salt release: 2019.2.1