<filename>venv/lib/python3.6/site-packages/ansible_collections/cisco/aci/plugins/modules/aci_cloud_epg.py
#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright: (c) 2021, <NAME> <<EMAIL>>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import absolute_import, division, print_function
__metaclass__ = type

DOCUMENTATION = r'''
---
module: aci_cloud_epg
short_description: Manage Cloud EPG (cloud:EPg)
description:
- Manage Cloud EPG on Cisco Cloud ACI
options:
  tenant:
    description:
    - The name of the existing tenant.
    type: str
  ap:
    description:
    - The name of the cloud application profile.
    aliases: [ app_profile, app_profile_name ]
    type: str
  name:
    description:
    - The name of the cloud EPG.
    aliases: [ cloud_epg, cloud_epg_name, epg, epg_name ]
    type: str
  description:
    description:
    - Description of the cloud EPG.
    aliases: [ descr ]
    type: str
  vrf:
    description:
    - The name of the VRF.
    type: str
    aliases: [ context, vrf_name ]
  state:
    description:
    - Use C(present) or C(absent) for adding or removing.
    - Use C(query) for listing an object or multiple objects.
    choices: [ absent, present, query ]
    default: present
    type: str
extends_documentation_fragment:
- cisco.aci.aci
notes:
- More information about the internal APIC class B(cloud:EPg) from
  L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author:
- Nirav (@nirav)
- <NAME> (@cizhao)
'''

EXAMPLES = r'''
- name: Create aci cloud epg (check_mode)
  cisco.aci.aci_cloud_epg:
    host: apic
    username: admin
    password: <PASSWORD>
    tenant: tenantName
    ap: apName
    vrf: vrfName
    description: Aci Cloud EPG
    name: epgName
    state: present
  delegate_to: localhost

- name: Remove cloud epg
  cisco.aci.aci_cloud_epg:
    host: apic
    username: admin
    password: <PASSWORD>
    tenant: tenantName
    ap: apName
    name: cloudName
    state: absent
  delegate_to: localhost

- name: query all
  cisco.aci.aci_cloud_epg:
    host: apic
    username: admin
    password: <PASSWORD>
    tenant: tenantName
    ap: apName
    state: query
  delegate_to: localhost

- name: query a specific cloud epg
  cisco.aci.aci_cloud_epg:
    host: apic
    username: admin
    password: <PASSWORD>
    tenant: tenantName
    ap: apName
    name: epgName
    state: query
  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_collections.cisco.aci.plugins.module_utils.aci import ACIModule, aci_argument_spec
from ansible.module_utils.basic import AnsibleModule


def main():
    argument_spec = aci_argument_spec()
    argument_spec.update({
        'description': dict(type='str', aliases=['descr']),
        'name': dict(type='str', aliases=['cloud_epg', 'cloud_epg_name', 'epg', 'epg_name']),
        'tenant': dict(type='str',),
        'ap': dict(type='str', aliases=['app_profile', 'app_profile_name']),
        'state': dict(type='str', default='present', choices=['absent', 'present', 'query']),
        'vrf': dict(type='str', aliases=['context', 'vrf_name']),
    })

    module = AnsibleModule(
        argument_spec=argument_spec,
        supports_check_mode=True,
        required_if=[
            ['state', 'absent', ['name', 'tenant', 'ap']],
            ['state', 'present', ['name', 'tenant', 'ap']],
        ],
    )

    description = module.params.get('description')
    name = module.params.get('name')
    tenant = module.params.get('tenant')
    ap = module.params.get('ap')
    state = module.params.get('state')
    child_configs = []
    relation_vrf = module.params.get('vrf')

    if relation_vrf:
        child_configs.append({'cloudRsCloudEPgCtx': {'attributes': {'tnFvCtxName': relation_vrf}}})

    aci = ACIModule(module)
    aci.construct_url(
        root_class={
            'aci_class': 'fvTenant',
            'aci_rn': 'tn-{0}'.format(tenant),
            'target_filter': 'eq(fvTenant.name, "{0}")'.format(tenant),
            'module_object': tenant
        },
        subclass_1={
            'aci_class': 'cloudApp',
            'aci_rn': 'cloudapp-{0}'.format(ap),
            'target_filter': 'eq(cloudApp.name, "{0}")'.format(ap),
            'module_object': ap
        },
        subclass_2={
            'aci_class': 'cloudEPg',
            'aci_rn': 'cloudepg-{0}'.format(name),
            'target_filter': 'eq(cloudEPg.name, "{0}")'.format(name),
            'module_object': name
        },
        child_classes=['cloudRsCloudEPgCtx']
    )

    aci.get_existing()

    if state == 'present':
        aci.payload(
            aci_class='cloudEPg',
            class_config={
                'descr': description,
                'name': name,
            },
            child_configs=child_configs
        )

        aci.get_diff(aci_class='cloudEPg')

        aci.post_config()

    elif state == 'absent':
        aci.delete_config()

    aci.exit_json()


if __name__ == "__main__":
    main()

<filename>venv/lib/python3.6/site-packages/ansible_collections/cisco/aci/plugins/modules/aci_cloud_epg.py
#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright: (c) 2021, <NAME> <<EMAIL>>
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import absolute_import, division, print_function
__metaclass__ = type

DOCUMENTATION = r'''
---
module: aci_cloud_epg
short_description: Manage Cloud EPG (cloud:EPg)
description:
- Manage Cloud EPG on Cisco Cloud ACI
options:
  tenant:
    description:
    - The name of the existing tenant.
    type: str
  ap:
    description:
    - The name of the cloud application profile.
    aliases: [ app_profile, app_profile_name ]
    type: str
  name:
    description:
    - The name of the cloud EPG.
    aliases: [ cloud_epg, cloud_epg_name, epg, epg_name ]
    type: str
  description:
    description:
    - Description of the cloud EPG.
    aliases: [ descr ]
    type: str
  vrf:
    description:
    - The name of the VRF.
    type: str
    aliases: [ context, vrf_name ]
  state:
    description:
    - Use C(present) or C(absent) for adding or removing.
    - Use C(query) for listing an object or multiple objects.
    choices: [ absent, present, query ]
    default: present
    type: str
extends_documentation_fragment:
- cisco.aci.aci
notes:
- More information about the internal APIC class B(cloud:EPg) from
  L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
author:
- Nirav (@nirav)
- <NAME> (@cizhao)
'''

EXAMPLES = r'''
- name: Create aci cloud epg (check_mode)
  cisco.aci.aci_cloud_epg:
    host: apic
    username: admin
    password: <PASSWORD>
    tenant: tenantName
    ap: apName
    vrf: vrfName
    description: Aci Cloud EPG
    name: epgName
    state: present
  delegate_to: localhost

- name: Remove cloud epg
  cisco.aci.aci_cloud_epg:
    host: apic
    username: admin
    password: <PASSWORD>
    tenant: tenantName
    ap: apName
    name: cloudName
    state: absent
  delegate_to: localhost

- name: query all
  cisco.aci.aci_cloud_epg:
    host: apic
    username: admin
    password: <PASSWORD>
    tenant: tenantName
    ap: apName
    state: query
  delegate_to: localhost

- name: query a specific cloud epg
  cisco.aci.aci_cloud_epg:
    host: apic
    username: admin
    password: <PASSWORD>
    tenant: tenantName
    ap: apName
    name: epgName
    state: query
  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_collections.cisco.aci.plugins.module_utils.aci import ACIModule, aci_argument_spec
from ansible.module_utils.basic import AnsibleModule


def main():
    argument_spec = aci_argument_spec()
    argument_spec.update({
        'description': dict(type='str', aliases=['descr']),
        'name': dict(type='str', aliases=['cloud_epg', 'cloud_epg_name', 'epg', 'epg_name']),
        'tenant': dict(type='str',),
        'ap': dict(type='str', aliases=['app_profile', 'app_profile_name']),
        'state': dict(type='str', default='present', choices=['absent', 'present', 'query']),
        'vrf': dict(type='str', aliases=['context', 'vrf_name']),
    })

    module = AnsibleModule(
        argument_spec=argument_spec,
        supports_check_mode=True,
        required_if=[
            ['state', 'absent', ['name', 'tenant', 'ap']],
            ['state', 'present', ['name', 'tenant', 'ap']],
        ],
    )

    description = module.params.get('description')
    name = module.params.get('name')
    tenant = module.params.get('tenant')
    ap = module.params.get('ap')
    state = module.params.get('state')
    child_configs = []
    relation_vrf = module.params.get('vrf')

    if relation_vrf:
        child_configs.append({'cloudRsCloudEPgCtx': {'attributes': {'tnFvCtxName': relation_vrf}}})

    aci = ACIModule(module)
    aci.construct_url(
        root_class={
            'aci_class': 'fvTenant',
            'aci_rn': 'tn-{0}'.format(tenant),
            'target_filter': 'eq(fvTenant.name, "{0}")'.format(tenant),
            'module_object': tenant
        },
        subclass_1={
            'aci_class': 'cloudApp',
            'aci_rn': 'cloudapp-{0}'.format(ap),
            'target_filter': 'eq(cloudApp.name, "{0}")'.format(ap),
            'module_object': ap
        },
        subclass_2={
            'aci_class': 'cloudEPg',
            'aci_rn': 'cloudepg-{0}'.format(name),
            'target_filter': 'eq(cloudEPg.name, "{0}")'.format(name),
            'module_object': name
        },
        child_classes=['cloudRsCloudEPgCtx']
    )

    aci.get_existing()

    if state == 'present':
        aci.payload(
            aci_class='cloudEPg',
            class_config={
                'descr': description,
                'name': name,
            },
            child_configs=child_configs
        )

        aci.get_diff(aci_class='cloudEPg')

        aci.post_config()

    elif state == 'absent':
        aci.delete_config()

    aci.exit_json()


if __name__ == "__main__":
    main()

#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2021, <NAME> <<EMAIL>> # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) --- module: aci_cloud_epg short_description: Manage Cloud EPG (cloud:EPg) description: - Manage Cloud EPG on Cisco Cloud ACI options:   tenant:     description:     - The name of the existing tenant.     type: str   ap:     description:     - The name of the cloud application profile.     aliases: [ app_profile, app_profile_name ]     type: str   name:     description:     - The name of the cloud EPG.     aliases: [ cloud_epg, cloud_epg_name, epg, epg_name ]     type: str   description:     description:     - Description of the cloud EPG.     aliases: [ descr ]     type: str   vrf:     description:     - The name of the VRF.     type: str     aliases: [ context, vrf_name ]   state:     description:     - Use C(present) or C(absent) for adding or removing.     - Use C(query) for listing an object or multiple objects.     choices: [ absent, present, query ]     default: present     type: str extends_documentation_fragment: - cisco.aci.aci notes: - More information about the internal APIC class B(cloud:EPg) from   L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/). author: - Nirav (@nirav) - <NAME> (@cizhao) - name: Create aci cloud epg (check_mode)   cisco.aci.aci_cloud_epg:     host: apic     username: admin     password: <PASSWORD>     tenant: tenantName     ap: apName     vrf: vrfName     description: Aci Cloud EPG     name: epgName     state: present   delegate_to: localhost  - name: Remove cloud epg   cisco.aci.aci_cloud_epg:     host: apic     username: admin     password: <PASSWORD>     tenant: tenantName     ap: apName     name: cloudName     state: absent   delegate_to: localhost  - name: query all   cisco.aci.aci_cloud_epg:     host: apic     username: admin     password: <PASSWORD>     tenant: tenantName     ap: apName     state: query   delegate_to: localhost  - name: query a specific cloud epg   cisco.aci.aci_cloud_epg:     host: apic     username: admin     password: <PASSWORD>     tenant: tenantName     ap: apName     name: epgName     state: query   delegate_to: localhost 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