Vh4& d dl mZmZmZ eZddgddZdZdZdZ d d l
m Z d d
l m
Z
mZmZmZ ed d d
d Zd Zedk( r e yy) )absolute_importdivisionprint_functionz1.1preview certified)metadata_versionstatus supported_bya,
---
module: aci_vrf
short_description: Manage contexts or VRFs (fv:Ctx)
description:
- Manage contexts or VRFs on Cisco ACI fabrics.
- Each context is a private network associated to a tenant, i.e. VRF.
- Enable Preferred Groups for VRF
options:
tenant:
description:
- The name of the Tenant the VRF should belong to.
type: str
aliases: [ tenant_name ]
vrf:
description:
- The name of the VRF.
type: str
aliases: [ context, name, vrf_name ]
policy_control_direction:
description:
- Determines if the policy should be enforced by the fabric on ingress or egress.
type: str
choices: [ egress, ingress ]
policy_control_preference:
description:
- Determines if the fabric should enforce contract policies to allow routing and packet forwarding.
type: str
choices: [ enforced, unenforced ]
description:
description:
- The description for the VRF.
type: str
aliases: [ descr ]
ip_data_plane_learning:
description:
- Whether IP data plane learning is enabled or disabled.
- The APIC defaults to C(enabled) when unset during creation.
type: str
choices: [ enabled, disabled ]
aliases: [ ip_dataplane_learning ]
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
preferred_group:
description:
- Enables preferred groups for the VRF under vzAny
type: str
choices: [enabled, disabled]
match_type:
description:
- Configures match type for contracts under vzAny
type: str
choices: [ all, at_least_one, at_most_one, none]
extends_documentation_fragment:
- cisco.aci.aci
- cisco.aci.annotation
- cisco.aci.owner
notes:
- The C(tenant) used must exist before using this module in your playbook.
The M(cisco.aci.aci_tenant) module can be used for this.
seealso:
- module: cisco.aci.aci_tenant
- name: APIC Management Information Model reference
description: More information about the internal APIC class B(fv:Ctx).
link: https://developer.cisco.com/docs/apic-mim-ref/
author:
- Jacob McGill (@jmcgill298)
a
- name: Add a new VRF to a tenant
cisco.aci.aci_vrf:
host: apic
username: admin
password: SomeSecretPassword
vrf: vrf_lab
tenant: lab_tenant
descr: Lab VRF
policy_control_preference: enforced
policy_control_direction: ingress
state: present
delegate_to: localhost
- name: Remove a VRF for a tenant
cisco.aci.aci_vrf:
host: apic
username: admin
password: SomeSecretPassword
vrf: vrf_lab
tenant: lab_tenant
state: absent
delegate_to: localhost
- name: Query a VRF of a tenant
cisco.aci.aci_vrf:
host: apic
username: admin
password: SomeSecretPassword
vrf: vrf_lab
tenant: lab_tenant
state: query
delegate_to: localhost
register: query_result
- name: Query all VRFs
cisco.aci.aci_vrf:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
a
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: ''
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
)
AnsibleModule) ACIModuleaci_argument_specaci_annotation_specaci_owner_specAll
AtleastOne AtmostOneNoneall at_least_one at_most_onenonec t } | j t | j t | j t ddg t dg d t ddg t dddg t dd d
g t dd g d
t dddg t dg d t d t dddgdg
t | dddddggdd ddggg }|j j d }|j j d }|j j d }|j j d }|j j d }|j j d }|j j d }|j j d } |j j d }
|j j d! } |
t |
}
t | } | j t d"d#j | |d$|i% t d&d'j | |d$|i% d(g) | j |d k( rf| j d&t |||||| * t t t | |
+ , - g. | j d&/ | j n|dk( r| j! | j# y )0Nstr tenant_name)typealiases)contextnamevrf_namedescregressingress)r choicesenforced
unenforcedpresent)absentr' query)r defaultr$ enableddisabledr )r ip_dataplane_learning)r r$ r )
tenantvrf descriptionpolicy_control_directionpolicy_control_preferencestatepreferred_group
match_type
name_aliasip_data_plane_learningTr3 r( r. r/ )
argument_specsupports_check_mode required_ifr0 r1 r2 r6 r4 r5 r7 fvTenantztn-{0}r ) aci_classaci_rn
module_object
target_filterfvCtxzctx-{0}vzAny)
root_class
subclass_1
child_classes)r! pcEnfDir pcEnfPrefr nameAliasipDataPlaneLearning)
prefGrMembmatchT)
attributes)rA )r< class_config
child_configs)r< )r
updater r dictr paramsgetMATCH_TYPE_MAPPINGr
construct_urlformat get_existingpayloadget_diff post_config
delete_config exit_json)
r8 moduler0 r1 r2 r3 r. r/ r6 r4 r5 r7 acis
e/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/aci/plugins/modules/aci_vrf.pymainr^ s %'M,./ )* 8 e%D EegY7!%58Y:O!P"&EJ ;U"Vy:XY %)Z1HIU,Z[U# #J8OZqYr s #
h5 1 2
i(E!2 3
F --##M2K %}} 0 01K L &
1 12M N MM g &E
]]
x
(F
--
E
"C ""<0J mm''(9:O ""<0J #]] . ./G H '
3
F
C ??6* !6*
##C( !3-
i !13$$:
44?S]+^_`
w ' ( MMO __main__N)
__future__r r r r
__metaclass__ANSIBLE_METADATA
DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicr 6ansible_collections.cisco.aci.plugins.module_utils.acir r
r r rO rR r^ __name__ r_ r] rk s A @
(-)Vab M
^+ Zg
R 5 E E
Rj zF r_