aci_l3out_route_tag_policy – Manage route tag policies (l3ext:RouteTagPol)
New in version 2.4.
Synopsis
- Manage route tag policies on Cisco ACI fabrics.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| certificate_name string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a private_key filename was provided, this defaults to the private_key basename, without extension.If PEM-formatted content was provided for private_key, this defaults to the username value.aliases: cert_name | |
| description string | The description for the route tag policy. aliases: descr | |
| host string / required | IP Address or hostname of APIC resolvable by Ansible control host. aliases: hostname | |
| output_level string |
| Influence the output of this ACI module. normal means the standard output, incl. current dictinfo adds informational output, incl. previous, proposed and sent dictsdebug adds debugging output, incl. filter_string, method, response, status and url information |
| password string / required | The password to use for authentication. This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead. | |
| port integer | Port number to be used for REST connection. The default value depends on parameter use_ssl. | |
| private_key string / required | Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default certificate_name that is used.This option is mutual exclusive with password. If password is provided too, it will be ignored.aliases: cert_key | |
| rtp string / required | The name of the route tag policy. aliases: name, rtp_name | |
| state string |
| Use present or absent for adding or removing.Use query for listing an object or multiple objects. |
| tag integer | The value of the route tag. Accepted values range between 0 and 4294967295.The APIC defaults to 4294967295 when unset during creation. | |
| tenant string / required | The name of the tenant. aliases: tenant_name | |
| timeout integer | Default: 30 | The socket level timeout in seconds. |
| use_proxy boolean |
| If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| use_ssl boolean |
| If no, an HTTP connection will be used instead of the default HTTPS connection. |
| username string | Default: "admin" | The username to use for authentication. aliases: user |
| validate_certs boolean |
| If no, SSL certificates will not be validated.This should only set to no when used on personally controlled sites using self-signed certificates. |
Notes
Note
- The
tenantused must exist before using this module in your playbook. The aci_tenant module can be used for this.
See Also
See also
- aci_tenant – Manage tenants (fv:Tenant)
- The official documentation on the aci_tenant module.
- APIC Management Information Model reference
- More information about the internal APIC class l3ext:RouteTagPol.
- Cisco ACI Guide
- Detailed information on how to manage your ACI infrastructure using Ansible.
- Developing Cisco ACI modules
- Detailed guide on how to write your own Cisco ACI modules to contribute.
Examples
- aci_l3out_route_tag_policy:
host: apic
username: admin
password: SomeSecretPassword
rtp: '{{ rtp_name }}'
tenant: production
tag: '{{ tag }}'
description: '{{ description }}'
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| current list | success | The existing configuration from the APIC after the module has finished Sample: [{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}] |
| error dictionary | failure | The error information as returned from the APIC Sample: {'code': '122', 'text': 'unknown managed object class foo'} |
| filter_string string | failure or debug | The filter string used for the request Sample: ?rsp-prop-include=config-only |
| method string | failure or debug | The HTTP method used for the request to the APIC Sample: POST |
| previous list | info | The original configuration from the APIC before the module has started Sample: [{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}] |
| proposed dictionary | info | The assembled configuration from the user-provided parameters Sample: {'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}} |
| raw string | parse error | The raw output returned by the APIC REST API (xml or json) Sample: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata> |
| response string | failure or debug | The HTTP response from the APIC Sample: OK (30 bytes) |
| sent list | info | The actual/minimal configuration pushed to the APIC Sample: {'fvTenant': {'attributes': {'descr': 'Production environment'}}} |
| status integer | failure or debug | The HTTP status from the APIC Sample: 200 |
| url string | failure or debug | The HTTP url used for the request to the APIC Sample: https://10.11.12.13/api/mo/uni/tn-production.json |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Dag Wieers (@dagwieers)
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.8/modules/aci_l3out_route_tag_policy_module.html