File: //lib/python3.9/site-packages/ansible_collections/cisco/aci/plugins/modules/aci_esg.py
# -*- coding: utf-8 -*-
# Copyright: (c) 2022, Sabari Jaganathan (@sajagana) <[email protected]>
# 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
ANSIBLE_METADATA = {"metadata_version": "1.1", "status": ["preview"], "supported_by": "certified"}
DOCUMENTATION = r"""
---
module: aci_esg
short_description: Manage Endpoint Security Groups (ESGs) objects (fv:ESg)
description:
- Manage Endpoint Security Groups (ESGs) on Cisco ACI fabrics.
options:
tenant:
description:
- Name of the tenant.
type: str
aliases: [ tenant_name ]
ap:
description:
- The name of the application profile.
type: str
aliases: [ app_profile, app_profile_name ]
esg:
description:
- Name of the Endpoint Security Group.
type: str
aliases: [ esg_name, name ]
admin_state:
description:
- Use C(false) to set 'Admin Up' on the ESG Admin state and is the default.
- Use C(true) to set 'Admin Shut' on the ESG Admin state
type: bool
choices: [ false, true ]
vrf:
description:
- Name of the VRF
type: str
aliases: [ vrf_name ]
description:
description:
- Endpoint security group description.
type: str
aliases: [ descr ]
intra_esg_isolation:
description:
- The default value of Intra ESG Isolation is C(unenforced).
type: str
choices: [ enforced, unenforced ]
preferred_group_member:
description:
- The default value of Preferred Group Member is C(exclude).
type: str
choices: [ exclude, include ]
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:
description:
- The alias for the current object. This relates to the nameAlias field in ACI.
type: str
extends_documentation_fragment:
- cisco.aci.aci
- cisco.aci.annotation
seealso:
- module: cisco.aci.aci_aep_to_domain
- name: APIC Management Information Model reference
description: More information about the internal APIC classes B(infra:AttEntityP) and B(infra:ProvAcc).
link: https://developer.cisco.com/docs/apic-mim-ref/
author:
- Sabari Jaganathan (@sajagana)
"""
EXAMPLES = r"""
- name: Add a new ESG
cisco.aci.aci_esg:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
ap: intranet
esg: web_esg
vrf: 'default'
description: Web Intranet ESG
state: present
delegate_to: localhost
- name: Add list of ESGs
cisco.aci.aci_esg:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
ap: ticketing
esg: "{{ item.esg }}"
description: Ticketing ESG
vrf: 'default'
state: present
delegate_to: localhost
with_items:
- esg: web
- esg: database
- name: Query an ESG
cisco.aci.aci_esg:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
ap: ticketing
esg: web_esg
state: query
delegate_to: localhost
- name: Query all ESGs
cisco.aci.aci_esg:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
- name: Query all ESGs with a Specific Name
cisco.aci.aci_esg:
host: apic
username: admin
password: SomeSecretPassword
esg: web_esg
state: query
delegate_to: localhost
- name: Query all ESGs of an App Profile
cisco.aci.aci_esg:
host: apic
username: admin
password: SomeSecretPassword
ap: ticketing
state: query
delegate_to: localhost
- name: Remove an ESG
cisco.aci.aci_esg:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
app_profile: intranet
esg: web_esg
state: absent
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_collections.cisco.aci.plugins.module_utils.aci import ACIModule, aci_argument_spec, aci_annotation_spec
def main():
argument_spec = aci_argument_spec()
argument_spec.update(aci_annotation_spec())
argument_spec.update(
tenant=dict(type="str", aliases=["tenant_name"]),
ap=dict(type="str", aliases=["app_profile", "app_profile_name"]),
esg=dict(type="str", aliases=["name", "esg_name"]),
admin_state=dict(type="bool", choices=[False, True]), # ESG Admin State
vrf=dict(type="str", aliases=["vrf_name"]), # ESG VRF name
description=dict(type="str", aliases=["descr"]),
intra_esg_isolation=dict(
type="str",
choices=["enforced", "unenforced"],
), # Intra ESG Isolation
preferred_group_member=dict(type="str", choices=["exclude", "include"]), # Preferred Group Member
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", ["tenant", "ap", "esg"]],
["state", "present", ["tenant", "ap", "esg", "vrf"]],
],
)
aci = ACIModule(module)
tenant = module.params.get("tenant")
ap = module.params.get("ap")
esg = module.params.get("esg")
admin_state = module.params.get("admin_state")
vrf = module.params.get("vrf")
description = module.params.get("description")
intra_esg_isolation = module.params.get("intra_esg_isolation")
preferred_group_member = module.params.get("preferred_group_member")
state = module.params.get("state")
name_alias = module.params.get("name_alias")
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="fvAp",
aci_rn="ap-{0}".format(ap),
module_object=ap,
target_filter={"name": ap},
),
subclass_2=dict(
aci_class="fvESg",
aci_rn="esg-{0}".format(esg),
module_object=esg,
target_filter={"name": esg},
),
child_classes=[
"fvRsScope",
],
)
aci.get_existing()
if state == "present":
state_mapping = {True: "yes", False: "no"}
shutdown = state_mapping.get(admin_state)
# VRF Selection - fvRsScope
aci.payload(
aci_class="fvESg",
class_config=dict(
name=esg,
descr=description,
shutdown=shutdown,
pcEnfPref=intra_esg_isolation,
prefGrMemb=preferred_group_member,
nameAlias=name_alias,
),
child_configs=[dict(fvRsScope=dict(attributes=dict(tnFvCtxName=vrf)))],
)
aci.get_diff(aci_class="fvESg")
aci.post_config()
elif state == "absent":
aci.delete_config()
aci.exit_json()
if __name__ == "__main__":
main()