Vh9 d dl mZmZmZ eZddgddZdZdZdZ d d l
m Z d d
l m
Z
mZmZmZ ed d d
dddd Z edddd ZddddZd Zed k( r e yy) )absolute_importdivisionprint_functionz1.1preview certified)metadata_versionstatus supported_bya
---
module: aci_domain
short_description: Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, and fc:DomP)
description:
- Manage physical, virtual, bridged, routed or FC domain profiles on Cisco ACI fabrics.
options:
domain:
description:
- Name of the physical, virtual, bridged routed or FC domain profile.
type: str
aliases: [ domain_name, domain_profile, name ]
domain_type:
description:
- The type of domain profile.
- 'C(fc): The FC domain profile is a policy pertaining to single FC Management domain'
- 'C(l2dom): The external bridged domain profile is a policy for managing L2 bridged infrastructure bridged outside the fabric.'
- 'C(l3dom): The external routed domain profile is a policy for managing L3 routed infrastructure outside the fabric.'
- 'C(phys): The physical domain profile stores the physical resources and encap resources that should be used for EPGs associated with this domain.'
- 'C(vmm): The VMM domain profile is a policy for grouping VM controllers with similar networking policy requirements.'
type: str
required: true
choices: [ fc, l2dom, l3dom, phys, vmm ]
aliases: [ type ]
dscp:
description:
- The target Differentiated Service (DSCP) value.
- The APIC defaults to C(unspecified) when unset during creation.
type: str
choices: [ AF11, AF12, AF13, AF21, AF22, AF23, AF31, AF32, AF33, AF41, AF42, AF43, CS0, CS1, CS2, CS3, CS4, CS5, CS6, CS7, EF, VA, unspecified ]
aliases: [ target ]
encap_mode:
description:
- The layer 2 encapsulation protocol to use with the virtual switch.
type: str
choices: [ unknown, vlan, vxlan ]
add_infra_pg:
description:
- Configure port groups for infra VLAN (e.g. Virtual APIC).
type: bool
aliases: [ infra_pg ]
tag_collection:
description:
- Enables Cisco APIC to collect VMs that have been assigned tags in VMware vCenter for microsegmentation.
type: bool
multicast_address:
description:
- The multicast IP address to use for the virtual switch.
type: str
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
vm_provider:
description:
- The VM platform for VMM Domains.
- Support for Kubernetes was added in ACI v3.0.
- Support for CloudFoundry, OpenShift and Red Hat was added in ACI v3.1.
type: str
choices: [ cloudfoundry, kubernetes, microsoft, openshift, openstack, redhat, vmware ]
vswitch:
description:
- The virtual switch to use for vmm domains.
- The APIC defaults to C(default) when unset during creation.
type: str
choices: [ avs, default, dvs, unknown ]
access_mode:
description:
- Access mode for vmm domains
- This parameter cannot be changed after a domain is created
type: str
choices: [ read-only, read-write ]
enable_vm_folder:
description:
- Enable VM folder data retrieval
type: bool
extends_documentation_fragment:
- cisco.aci.aci
- cisco.aci.annotation
- cisco.aci.owner
seealso:
- module: cisco.aci.aci_aep_to_domain
- module: cisco.aci.aci_domain_to_encap_pool
- module: cisco.aci.aci_domain_to_vlan_pool
- name: APIC Management Information Model reference
description: More information about the internal APIC classes B(phys:DomP),
B(vmm:DomP), B(l2ext:DomP), B(l3ext:DomP) and B(fc:DomP)
link: https://developer.cisco.com/docs/apic-mim-ref/
author:
- Dag Wieers (@dagwieers)
a
- name: Add a new physical domain
cisco.aci.aci_domain:
host: apic
username: admin
password: SomeSecretPassword
domain: phys_dom
domain_type: phys
state: present
- name: Remove a physical domain
cisco.aci.aci_domain:
host: apic
username: admin
password: SomeSecretPassword
domain: phys_dom
domain_type: phys
state: absent
- name: Add a new VMM domain
cisco.aci.aci_domain:
host: apic
username: admin
password: SomeSecretPassword
domain: hyperv_dom
domain_type: vmm
vm_provider: microsoft
state: present
delegate_to: localhost
- name: Remove a VMM domain
cisco.aci.aci_domain:
host: apic
username: admin
password: SomeSecretPassword
domain: hyperv_dom
domain_type: vmm
vm_provider: microsoft
state: absent
delegate_to: localhost
- name: Query a specific physical domain
cisco.aci.aci_domain:
host: apic
username: admin
password: SomeSecretPassword
domain: phys_dom
domain_type: phys
state: query
delegate_to: localhost
register: query_result
- name: Query all domains
cisco.aci.aci_domain:
host: apic
username: admin
password: SomeSecretPassword
domain_type: phys
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_spec CloudFoundry
Kubernetes Microsoft OpenShift OpenStackRedhatVMware cloudfoundry
kubernetes microsoft openshift openstackredhatvmwaren1kvdefaultunknownavsr dvsr! yesnoN)TFNc
t } | j t | j t | j t ddg ddg t dg d t dg dd g
t dg d t d
dg t d
t d t ddg d t dg d t dg d t d t dddg t d
t | ddddggdd d dggddd dggg }|j j d }|j j d }|j j d }|j j d }t |j j d! }t |j j d" }|j j d# }|j j d } |j j d$ }
|
t j |
}
|j j d% } t |j j d& } |j j d }
|j j d' }|dk7 r| !|j d(j | ) |!|j d*j | ) |!|j d+j | ) |
!|j d,j | ) | !|j d-j | ) | !|j d.j | ) ||d/vr|j d0) |d1k( r%d2}d3j | }d4j | }n|d5k( r%d6}d7j | }d8j | }n|d9k( r%d:}d;j | }d}d?j | }d@j | }nQ|dk( rLdA}dBj t j | | }dCj t j | | }|d }t | }|j t dD|iE F |j |
dk( rI|j! |t |||||
|||| | G
H |j# |I |j% n|
d k( r|j' |j) y )JNstrT)fcl2doml3domphysvmmtype)r. requiredchoicesaliases) domain_namedomain_profilename)r. r1 )AF11AF12AF13AF21AF22AF23AF31AF32AF33AF41AF42AF43CS0CS1CS2CS3CS4CS5CS6CS7EFVA unspecifiedtarget)r. r0 r1 )r! vlanvxlan)r. r0 boolinfra_pg)r. present)absentrQ query)r. r r0 r r" z
read-writez read-only)
domain_typedomaindscp
encap_mode add_infra_pgtag_collectionmulticast_addressstate vm_providervswitch
name_alias access_modeenable_vm_folderrT r- r\ r[ rR rU )
argument_specsupports_check_mode required_ifrV rW rX rY rZ r] r_ r` r^ z5Domain type '{0}' cannot have parameter 'vm_provider')msgz4Domain type '{0}' cannot have parameter 'encap_mode'z;Domain type '{0}' cannot have parameter 'multicast_address'z1Domain type '{0}' cannot have parameter 'vswitch'z5Domain type '{0}' cannot have parameter 'access_mode'z:Domain type '{0}' cannot have parameter 'enable_vm_folder')r* r+ z>DSCP values can only be assigned to 'l2ext and 'l3ext' domainsr) fcDomPz
uni/fc-{0}zfc-{0}r* l2extDomPz
uni/l2dom-{0}z l2dom-{0}r+ l3extDomPz
uni/l3dom-{0}z l3dom-{0}r, physDomPz uni/phys-{0}zphys-{0}vmmDomPzuni/vmmp-{0}/dom-{1}zvmmp-{0}/dom-{1}r4 ) aci_classaci_rn
module_object
target_filter)
root_class)
encapMode mcastAddr
configInfraPg enableTagmoder4
targetDscp nameAlias
accessModeenableVmFolder)rj class_config)rj )r
updater r dictr paramsgetBOOL_TO_ACI_MAPPINGVSWITCH_MAPPING fail_jsonformatVM_PROVIDER_MAPPINGr
construct_url get_existingpayloadget_diff post_config
delete_config exit_json)ra modulerV rU rT rW rX rY rZ r\ r] r_ r` r[ r^ domain_class domain_mo domain_rnacis h/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/aci/plugins/modules/aci_domain.pymainr / s! %'M,./ )*ed--##M2Kmm *G!%%g.--##M2K*6==+<+<=O+PQ MM g &E ""<0Je " !X!_!_`k!l m ! !W!^!^_j!k l ( !^!e!efq!r s !T![![\g!h i " !X!_!_`k!l m ' !]!d!dep!q r K/A A ]^ d ''/ OOF+ " #**62 &&v. " #**62 &&v. ! "))&1 %%f- *112E2I2I+2VX^_ &--.A.E.Ek.RTZ[ ~
F
C" #!6*
" $+ *( $& /
| , ( MMO __main__)
__future__r r r r.
__metaclass__ANSIBLE_METADATA
DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicr 6ansible_collections.cisco.aci.plugins.module_utils.acir r
r r rz r r~ r} r __name__ r r r s A @
(-)Vab b
H= ~g
R 5 E E #4t< Yx zF r