summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py')
-rw-r--r--lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py257
1 files changed, 0 insertions, 257 deletions
diff --git a/lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py b/lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py
deleted file mode 100644
index ccc8ed5c14..0000000000
--- a/lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py
+++ /dev/null
@@ -1,257 +0,0 @@
-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-
-from __future__ import absolute_import, division, print_function
-__metaclass__ = type
-
-ANSIBLE_METADATA = {'metadata_version': '1.1',
- 'status': ['preview'],
- 'supported_by': 'certified'}
-
-DOCUMENTATION = r'''
----
-module: aci_l3out_route_tag_policy
-short_description: Manage route tag policies (l3ext:RouteTagPol)
-description:
-- Manage route tag policies on Cisco ACI fabrics.
-version_added: '2.4'
-options:
- rtp:
- description:
- - The name of the route tag policy.
- type: str
- required: yes
- aliases: [ name, rtp_name ]
- description:
- description:
- - The description for the route tag policy.
- type: str
- aliases: [ descr ]
- tenant:
- description:
- - The name of the tenant.
- type: str
- required: yes
- aliases: [ tenant_name ]
- tag:
- description:
- - The value of the route tag.
- - Accepted values range between C(0) and C(4294967295).
- - The APIC defaults to C(4294967295) when unset during creation.
- type: int
- state:
- description:
- - Use C(present) or C(absent) for adding or removing.
- - Use C(query) for listing an object or multiple objects.
- type: str
- choices: [ absent, present, query ]
- default: present
- name_alias:
- version_added: '2.10'
- description:
- - The alias for the current object. This relates to the nameAlias field in ACI.
- type: str
-extends_documentation_fragment: aci
-notes:
-- The C(tenant) used must exist before using this module in your playbook.
- The M(aci_tenant) module can be used for this.
-seealso:
-- module: aci_tenant
-- name: APIC Management Information Model reference
- description: More information about the internal APIC class B(l3ext:RouteTagPol).
- link: https://developer.cisco.com/docs/apic-mim-ref/
-author:
-- Dag Wieers (@dagwieers)
-'''
-
-# FIXME: Add more, better examples
-EXAMPLES = r'''
-- aci_l3out_route_tag_policy:
- host: apic
- username: admin
- password: SomeSecretPassword
- rtp: '{{ rtp_name }}'
- tenant: production
- tag: '{{ tag }}'
- description: '{{ description }}'
- delegate_to: localhost
-'''
-
-RETURN = r'''
-current:
- description: The existing configuration from the APIC after the module has finished
- returned: success
- type: list
- sample:
- [
- {
- "fvTenant": {
- "attributes": {
- "descr": "Production environment",
- "dn": "uni/tn-production",
- "name": "production",
- "nameAlias": "",
- "ownerKey": "",
- "ownerTag": ""
- }
- }
- }
- ]
-error:
- description: The error information as returned from the APIC
- returned: failure
- type: dict
- sample:
- {
- "code": "122",
- "text": "unknown managed object class foo"
- }
-raw:
- description: The raw output returned by the APIC REST API (xml or json)
- returned: parse error
- type: str
- sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>'
-sent:
- description: The actual/minimal configuration pushed to the APIC
- returned: info
- type: list
- sample:
- {
- "fvTenant": {
- "attributes": {
- "descr": "Production environment"
- }
- }
- }
-previous:
- description: The original configuration from the APIC before the module has started
- returned: info
- type: list
- sample:
- [
- {
- "fvTenant": {
- "attributes": {
- "descr": "Production",
- "dn": "uni/tn-production",
- "name": "production",
- "nameAlias": "",
- "ownerKey": "",
- "ownerTag": ""
- }
- }
- }
- ]
-proposed:
- description: The assembled configuration from the user-provided parameters
- returned: info
- type: dict
- sample:
- {
- "fvTenant": {
- "attributes": {
- "descr": "Production environment",
- "name": "production"
- }
- }
- }
-filter_string:
- description: The filter string used for the request
- returned: failure or debug
- type: str
- sample: ?rsp-prop-include=config-only
-method:
- description: The HTTP method used for the request to the APIC
- returned: failure or debug
- type: str
- sample: POST
-response:
- description: The HTTP response from the APIC
- returned: failure or debug
- type: str
- sample: OK (30 bytes)
-status:
- description: The HTTP status from the APIC
- returned: failure or debug
- type: int
- sample: 200
-url:
- description: The HTTP url used for the request to the APIC
- returned: failure or debug
- type: str
- sample: https://10.11.12.13/api/mo/uni/tn-production.json
-'''
-
-from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.network.aci.aci import ACIModule, aci_argument_spec
-
-
-def main():
- argument_spec = aci_argument_spec()
- argument_spec.update(
- tenant=dict(type='str', aliases=['tenant_name']), # Not required for querying all objects
- rtp=dict(type='str', aliases=['name', 'rtp_name']), # Not required for querying all objects
- description=dict(type='str', aliases=['descr']),
- tag=dict(type='int'),
- state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
- name_alias=dict(type='str'),
- )
-
- module = AnsibleModule(
- argument_spec=argument_spec,
- supports_check_mode=True,
- required_if=[
- ['state', 'absent', ['rtp', 'tenant']],
- ['state', 'present', ['rtp', 'tenant']],
- ],
- )
-
- rtp = module.params.get('rtp')
- description = module.params.get('description')
- tag = module.params.get('tag')
- state = module.params.get('state')
- tenant = module.params.get('tenant')
- name_alias = module.params.get('name_alias')
-
- aci = ACIModule(module)
- aci.construct_url(
- root_class=dict(
- aci_class='fvTenant',
- aci_rn='tn-{0}'.format(tenant),
- module_object=tenant,
- target_filter={'name': tenant},
- ),
- subclass_1=dict(
- aci_class='l3extRouteTagPol',
- aci_rn='rttag-{0}'.format(rtp),
- module_object=rtp,
- target_filter={'name': rtp},
- ),
- )
-
- aci.get_existing()
-
- if state == 'present':
- aci.payload(
- aci_class='l3extRouteTagPol',
- class_config=dict(
- name=rtp,
- descr=description, tag=tag,
- nameAlias=name_alias,
- ),
- )
-
- aci.get_diff(aci_class='l3extRouteTagPol')
-
- aci.post_config()
-
- elif state == 'absent':
- aci.delete_config()
-
- aci.exit_json()
-
-
-if __name__ == "__main__":
- main()