os_port - Add/Update/Delete ports from an OpenStack cloud.

New in version 2.0.

Synopsis

Add, Update or Remove ports from an OpenStack cloud. A state of ‘present’ will ensure the port is created or updated if required.

Requirements

The below requirements are needed on the host that executes this module.

python >= 2.7
shade

Parameters

Parameter	Choices/Defaults	Comments
admin_state_up	Default: None	Sets admin state.
allowed_address_pairs	Default: None	Allowed address pairs list. Allowed address pairs are supported with dictionary structure. e.g. allowed_address_pairs: - ip_address: 10.1.0.12 mac_address: ab:cd:ef:12:34:56 - ip_address: ...
api_timeout		How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
auth		Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
auth_type		Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
availability_zone		Ignored. Present for backwards compatibility
cacert		A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert		A path to a client certificate to use as part of the SSL transaction.
cloud		Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
device_id	Default: None	Device ID of device using this port.
device_owner	Default: None	The ID of the entity that uses this port.
extra_dhcp_opts	Default: None	Extra dhcp options to be assigned to this port. Extra options are supported with dictionary structure. e.g. extra_dhcp_opts: - opt_name: opt name1 opt_value: value1 - opt_name: ...
fixed_ips	Default: None	Desired IP and/or subnet for this port. Subnet is referenced by subnet_id and IP is referenced by ip_address.
interface (added in 2.3)	Choices: public ← internal admin	Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
key		A path to a client key to use as part of the SSL transaction.
mac_address	Default: None	MAC address of this port.
name	Default: None	Name that has to be given to the port.
network required		Network ID or name this port belongs to.
no_security_groups	Default: no	Do not associate a security group with this port.
region_name		Name of the region.
security_groups	Default: None	Security group(s) ID(s) or name(s) associated with the port (comma separated string or YAML list)
state	Choices: present ← absent	Should the resource be present or absent.
timeout	Default: 180	How long should ansible wait for the requested resource.
verify	Choices: no yes	Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True. aliases: validate_certs
wait	Choices: no yes ←	Should ansible wait until the requested resource is complete.

Notes

Note

The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
Auth information is driven by os-client-config, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at http://docs.openstack.org/developer/os-client-config

Examples

# Create a port
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    network: foo

# Create a port with a static IP
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    network: foo
    fixed_ips:
      - ip_address: 10.1.0.21

# Create a port with No security groups
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    network: foo
    no_security_groups: True

# Update the existing 'port1' port with multiple security groups (version 1)
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    security_groups: 1496e8c7-4918-482a-9172-f4f00fc4a3a5,057d4bdf-6d4d-472...

# Update the existing 'port1' port with multiple security groups (version 2)
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    security_groups:
      - 1496e8c7-4918-482a-9172-f4f00fc4a3a5
      - 057d4bdf-6d4d-472...

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
admin_state_up bool	success	Admin state up flag for this port.
allowed_address_pairs list	success	Allowed address pairs with this port.
fixed_ips list	success	Fixed ip(s) associated with this port.
id string	success	Unique UUID.
name string	success	Name given to the port.
network_id string	success	Network ID this port belongs in.
security_groups list	success	Security group(s) associated with this port.
status string	success	Port's status.
tenant_id string	success	Tenant id associated with this port.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Davide Agnello (@dagnello)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/os_port_module.html

Docs

Docs4dev

Title here