openstack.cloud.routers_info – Retrieve information about one or more OpenStack routers.

Note

This plugin is part of the openstack.cloud collection (version 1.5.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install openstack.cloud.

To use it in a playbook, specify: openstack.cloud.routers_info.

Synopsis

Retrieve information about one or more routers from OpenStack.

Requirements

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Parameters

Parameter		Choices/Defaults	Comments
api_timeout integer			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			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 (for example, user_domain_name or project_domain_name) 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 string			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 string			Ignored. Present for backwards compatibility
ca_cert string			A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert
client_cert string			A path to a client certificate to use as part of the SSL transaction. aliases: cert
client_key string			A path to a client key to use as part of the SSL transaction. aliases: key
cloud raw			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.
filters dictionary			A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries.
	admin_state_up boolean	Choices: no yes	Filter the list result by the administrative state of the resource, which is up (true) or down (false).
	description string		Filter the list result by the human-readable description of the resource.
	name string		Filter the list result by the human-readable name of the resource.
	project_id string		Filter the list result by the ID of the project that owns the resource. aliases: tenant_id
	revision_number integer		Filter the list result by the revision number of the resource.
	tags list / elements=string		A list of tags to filter the list result by. Resources that match all tags in this list will be returned.
interface string		Choices: admin internal public ←	Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
name string			Name or ID of the router
region_name string			Name of the region.
timeout integer		Default: 180	How long should ansible wait for the requested resource.
validate_certs boolean		Choices: no yes	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify
wait boolean		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 openstacksdk, 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 https://docs.openstack.org/openstacksdk/

Examples

- name: Gather information about routers
  openstack.cloud.routers_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
  register: result

- name: Show openstack routers
  debug:
    msg: "{{ result.openstack_routers }}"

- name: Gather information about a router by name
  openstack.cloud.routers_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    name: router1
  register: result

- name: Show openstack routers
  debug:
    msg: "{{ result.openstack_routers }}"

- name: Gather information about a router with filter
  openstack.cloud.routers_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    filters:
      tenant_id: bc3ea709c96849d6b81f54640400a19f
  register: result

- name: Show openstack routers
  debug:
    msg: "{{ result.openstack_routers }}"

Return Values

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

Key		Returned	Description
openstack_routers complex		always, but can be null	has all the openstack information about the routers
	distributed boolean	success	Indicates a distributed router.
	external_gateway_info dictionary	success	The external gateway information of the router.
	ha boolean	success	Indicates a highly-available router.
	id string	success	Unique UUID.
	interfaces_info list / elements=string	success	List of connected interfaces.
	name string	success	Name given to the router.
	project_id string	success	Project id associated with this router.
	routes list / elements=string	success	The extra routes configuration for L3 router.
	status string	success	Router status.

Authors

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/routers_info_module.html

Docs

Docs4dev

Title here