You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

Cisco.Aci

Collection version 2.8.0

Description

Ansible Modules for Cisco ACI

Authors:

• Dag Wieers (@dagwieers) <dag@wieers.com>

• Swetha Chunduri (@schunduri)

• Jacob McGill (@jmcgill298)

• Rob Huelga (@RobW3LGA)

• Bruno Calogero <brunocalogero@hotmail.com>

• Simon Metzger <smnmtzgr@gmail.com>

• Tim Knipper <tim.knipper@gmail.com>

• Apoorva Gururaja (@aciguru)

• Devarshi Shah (@devarshishah3)

• Ramses Smeyers (@rsmeyers)

• Lionel Hercot (@lhercot) <lhercot@cisco.com>

Supported ansible-core versions:

• 2.9.10 or newer

• Issue Tracker
• Repository (Sources)

Plugin Index

These are the plugins in the cisco.aci collection:

Modules

• aci_aaa_custom_privilege module – Manage AAA RBAC Custom Privileges (aaa:RbacClassPriv)

• aci_aaa_domain module – Manage AAA domains (aaa:Domain)

• aci_aaa_role module – Manage AAA roles (aaa:Role)

• aci_aaa_ssh_auth module – Manage AAA SSH auth (aaaSshAuth) objects.

• aci_aaa_user module – Manage AAA users (aaa:User)

• aci_aaa_user_certificate module – Manage AAA user certificates (aaa:UserCert)

• aci_aaa_user_domain module – Manage AAA user domains (aaa:UserDomain)

• aci_aaa_user_role module – Manage AAA user roles (aaa:UserRole)

• aci_access_port_block_to_access_port module – Manage port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:PortBlk)

• aci_access_port_to_interface_policy_leaf_profile module – Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)

• aci_access_span_dst_group module – Manage Access SPAN destination groups (span:DestGrp)

• aci_access_span_filter_group module – Manage Access SPAN filter groups (span:FilterGrp)

• aci_access_span_filter_group_entry module – Manage Access SPAN filter group entries (span:FilterEntry)

• aci_access_span_src_group module – Manage Access SPAN source groups (span:SrcGrp)

• aci_access_span_src_group_src module – Manage Access SPAN sources (span:Src)

• aci_access_span_src_group_src_path module – Manage Access SPAN source paths (span:RsSrcToPathEp)

• aci_access_sub_port_block_to_access_port module – Manage sub port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:SubPortBlk)

• aci_aep module – Manage attachable Access Entity Profile (AEP) objects (infra:AttEntityP, infra:ProvAcc)

• aci_aep_to_domain module – Bind AEPs to Physical or Virtual Domains (infra:RsDomP)

• aci_aep_to_epg module – Bind EPG to AEP (infra:RsFuncToEpg).

• aci_ap module – Manage top level Application Profile (AP) objects (fv:Ap)

• aci_bd module – Manage Bridge Domains (BD) objects (fv:BD)

• aci_bd_dhcp_label module – Manage DHCP Labels (dhcp:Lbl)

• aci_bd_subnet module – Manage Subnets (fv:Subnet)

• aci_bd_to_l3out module – Bind Bridge Domain to L3 Out (fv:RsBDToOut)

• aci_bgp_best_path_policy module – Manage BGP Best Path policy (bgp:BestPathCtrlPol)

• aci_bgp_rr_asn module – Manage BGP Route Reflector ASN.

• aci_bgp_rr_node module – Manage BGP Route Reflector objects.

• aci_bgp_timers_policy module – Manage BGP timers policy (bgp:CtxPol)

• aci_bulk_static_binding_to_epg module – Bind static paths to EPGs (fv:RsPathAtt)

• aci_cloud_ap module – Manage Cloud Application Profile (AP) (cloud:App)

• aci_cloud_aws_provider module – Manage Cloud AWS Provider (cloud:AwsProvider)

• aci_cloud_bgp_asn module – Manage Cloud APIC BGP Autonomous System Profile (cloud:BgpAsP)

• aci_cloud_cidr module – Manage CIDR under Cloud Context Profile (cloud:Cidr)

• aci_cloud_ctx_profile module – Manage Cloud Context Profile (cloud:CtxProfile)

• aci_cloud_epg module – Manage Cloud EPG (cloud:EPg)

• aci_cloud_epg_selector module – Manage Cloud Endpoint Selector (cloud:EPSelector)

• aci_cloud_external_epg module – Manage Cloud External EPG (cloud:ExtEPg)

• aci_cloud_external_epg_selector module – Manage Cloud Endpoint Selector for External EPGs (cloud:ExtEPSelector)

• aci_cloud_provider module – Query Cloud Provider information (cloud:ProvP)

• aci_cloud_region module – Manage Cloud Providers Region (cloud:Region)

• aci_cloud_subnet module – Manage Cloud Subnet (cloud:Subnet)

• aci_cloud_vpn_gateway module – Manage cloudRouterP in Cloud Context Profile (cloud:cloudRouterP)

• aci_cloud_zone module – Manage Cloud Availability Zone (cloud:Zone)

• aci_config_export_policy module – Manage Configuration Export Policy (config:ExportP)

• aci_config_rollback module – Provides rollback and rollback preview functionality (config:ImportP)

• aci_config_snapshot module – Manage Config Snapshots (config:Snapshot, config:ExportP)

• aci_contract module – Manage contract resources (vz:BrCP)

• aci_contract_export module – Manage contract interfaces (vz:CPIf)

• aci_contract_subject module – Manage initial Contract Subjects (vz:Subj)

• aci_contract_subject_to_filter module – Bind Contract Subjects to Filters (vz:RsSubjFiltAtt)

• aci_contract_subject_to_service_graph module – Bind contract subject to service graph (vz:RsSubjGraphAtt).

• aci_dhcp_relay module – Manage DHCP relay policies.

• aci_dhcp_relay_provider module – Manage DHCP relay policy providers.

• aci_dns_domain module – Manage DNS Provider (dnsDomain) objects.

• aci_dns_profile module – Manage DNS Profile (dnsProfile) objects.

• aci_dns_provider module – Manage DNS Provider (dnsProv) objects.

• aci_domain module – Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)

• aci_domain_to_encap_pool module – Bind Domain to Encap Pools (infra:RsVlanNs)

• aci_domain_to_vlan_pool module – Bind Domain to VLAN Pools (infra:RsVlanNs)

• aci_encap_pool module – Manage encap pools (fvns:VlanInstP, fvns:VxlanInstP, fvns:VsanInstP)

• aci_encap_pool_range module – Manage encap ranges assigned to pools (fvns:EncapBlk, fvns:VsanEncapBlk)

• aci_epg module – Manage End Point Groups (EPG) objects (fv:AEPg)

• aci_epg_monitoring_policy module – Manage monitoring policies (mon:EPGPol)

• aci_epg_subnet module – Manage EPG Subnets (fv:Subnet)

• aci_epg_to_contract module – Bind EPGs to Contracts (fv:RsCons, fv:RsProv)

• aci_epg_to_contract_interface module – Bind EPGs to Consumed Contracts Interface (fv:RsConsIf).

• aci_epg_to_contract_master module – Manage End Point Group (EPG) contract master relationships (fv:RsSecInherited)

• aci_epg_to_domain module – Bind EPGs to Domains (fv:RsDomAtt)

• aci_esg module – Manage Endpoint Security Groups (ESGs) objects (fv:ESg)

• aci_esg_contract_master module – Manage ESG contract master relationships (fv:RsSecInherited)

• aci_esg_epg_selector module – Manage ESG - EPG Selectors (fv:fvEPgSelector)

• aci_esg_ip_subnet_selector module – Manage ESG IP Subnet selector(fv:EPSelector)

• aci_esg_tag_selector module – Manage ESG Tag Selectors (fv:TagSelector)

• aci_fabric_interface_policy_group module – Manage Fabric Interface Policy Groups (fabric:LePortPGrp, fabric:SpPortPGrp)

• aci_fabric_leaf_profile module – Manage fabric leaf profiles (fabric:LeafP).

• aci_fabric_leaf_switch_assoc module – Manage leaf switch bindings to profiles and policy groups (fabric:LeafS and fabric:RsLeNodePGrp).

• aci_fabric_node module – Manage Fabric Node Members (fabric:NodeIdentP)

• aci_fabric_node_control module – Manage Fabric Node Controls (fabric:NodeControl)

• aci_fabric_pod_policy_group module – Manage Fabric Pod Policy Groups (fabric:PodPGrp)

• aci_fabric_pod_selector module – Manage Fabric Pod Selectors (fabric:PodS)

• aci_fabric_scheduler module – This module creates ACI schedulers (trig:SchedP)

• aci_fabric_span_dst_group module – Manage Fabric SPAN destination groups (span:DestGrp)

• aci_fabric_span_src_group module – Manage Fabric SPAN source groups (span:SrcGrp)

• aci_fabric_span_src_group_src module – Manage Fabric SPAN sources (span:Src)

• aci_fabric_span_src_group_src_node module – Manage Fabric SPAN source nodes (span:RsSrcToNode)

• aci_fabric_span_src_group_src_path module – Manage Fabric SPAN source paths (span:RsSrcToPathEp)

• aci_fabric_spine_profile module – Manage fabric spine profiles (fabric:SpineP).

• aci_fabric_spine_switch_assoc module – Manage spine switch bindings to profiles and policy groups (fabric:SpineS and fabric:RsSpNodePGrp).

• aci_fabric_switch_block module – Manage switch blocks (fabric:NodeBlk).

• aci_fabric_switch_policy_group module – Manage Fabric Switch Policy Group objects.

• aci_fabric_wide_settings module – Manage Fabric Wide Settings (infra:SetPol)

• aci_file_remote_path module – Manage Import/Export File Remote Paths (file:RemotePath)

• aci_filter module – Manages top level filter objects (vz:Filter)

• aci_filter_entry module – Manage filter entries (vz:Entry)

• aci_firmware_group module – Manage firmware groups (firmware:FwGrp)

• aci_firmware_group_node module – Manage firmware group nodes (fabric:NodeBlk)

• aci_firmware_policy module – Manage firmware policies (firmware:FwP)

• aci_firmware_source module – Manage firmware image sources (firmware:OSource)

• aci_igmp_interface_policy module – Manage IGMP Interface Policies (igmp:IfPol)

• aci_interface_blacklist module – Enabling or Disabling physical interfaces.

• aci_interface_config module – Manage Interface Configuration of Access (infra:PortConfig) and Fabric (fabric:PortConfig) Ports is only supported for ACI 5.2(7)+

• aci_interface_description module – Setting and removing description on physical interfaces.

• aci_interface_policy_cdp module – Manage CDP interface policies (cdp:IfPol)

• aci_interface_policy_fc module – Manage Fibre Channel interface policies (fc:IfPol)

• aci_interface_policy_l2 module – Manage Layer 2 interface policies (l2:IfPol)

• aci_interface_policy_leaf_breakout_port_group module – Manage fabric interface policy leaf breakout port group (infra:BrkoutPortGrp)

• aci_interface_policy_leaf_fc_policy_group module – Manage Fibre Channel (FC) interface policy groups (infra:FcAccBndlGrp, infra:FcAccPortGrp)

• aci_interface_policy_leaf_policy_group module – Manage fabric interface policy leaf policy groups (infra:AccBndlGrp, infra:AccPortGrp)

• aci_interface_policy_leaf_profile module – Manage fabric interface policy leaf profiles (infra:AccPortP)

• aci_interface_policy_leaf_profile_fex_policy_group module – Manage leaf interface profiles fex policy group (infra:FexBndlGrp)

• aci_interface_policy_link_level module – Manage Link Level interface policies (fabric:HIfPol)

• aci_interface_policy_lldp module – Manage LLDP interface policies (lldp:IfPol)

• aci_interface_policy_mcp module – Manage MCP interface policies (mcp:IfPol)

• aci_interface_policy_ospf module – Manage OSPF interface policies (ospf:IfPol)

• aci_interface_policy_port_channel module – Manage port channel interface policies (lacp:LagPol)

• aci_interface_policy_port_security module – Manage port security (l2:PortSecurityPol)

• aci_interface_policy_spanning_tree module – Manage spanning tree interface policies (stp:IfPol)

• aci_interface_policy_spine_policy_group module – Manage spine access interface policy groups (infra:SpAccPortGrp)

• aci_interface_selector_to_switch_policy_leaf_profile module – Bind interface selector profiles to switch policy leaf profiles (infra:RsAccPortP)

• aci_l2out module – Manage Layer2 Out (L2Out) objects.

• aci_l2out_extepg module – Manage External Network Instance (L2Out External EPG) objects (l2extInstP).

• aci_l2out_extepg_to_contract module – Bind Contracts to L2 External End Point Groups (EPGs)

• aci_l2out_logical_interface_path module – Manage Layer 2 Outside (L2Out) logical interface path (l2extRsPathL2OutAtt)

• aci_l2out_logical_interface_profile module – Manage Layer 2 Outside (L2Out) interface profiles (l2ext:LIfP)

• aci_l2out_logical_node_profile module – Manage Layer 2 Outside (L2Out) logical node profiles (l2ext:LNodeP)

• aci_l3out module – Manage Layer 3 Outside (L3Out) objects (l3ext:Out)

• aci_l3out_bgp_peer module – Manage Layer 3 Outside (L3Out) BGP Peers (bgp:PeerP)

• aci_l3out_bgp_protocol_profile module – Manage BGP Protocol Profile (bgp:ProtP)

• aci_l3out_extepg module – Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP)

• aci_l3out_extepg_to_contract module – Bind Contracts to External End Point Groups (EPGs)

• aci_l3out_extsubnet module – Manage External Subnet objects (l3extSubnet:extsubnet)

• aci_l3out_interface module – Manage Layer 3 Outside (L3Out) interfaces (l3ext:RsPathL3OutAtt)

• aci_l3out_interface_secondary_ip module – Manage Layer 3 Outside (L3Out) interface secondary IP addresses (l3ext:Ip).

• aci_l3out_logical_interface_profile module – Manage Layer 3 Outside (L3Out) logical interface profiles (l3ext:LIfP)

• aci_l3out_logical_interface_profile_ospf_policy module – Manage Layer 3 Outside (L3Out) logical interface profile (l3ext:LIfP) OSPF policy (ospfIfP)

• aci_l3out_logical_interface_vpc_member module – Manage Member Node objects (l3ext:Member)

• aci_l3out_logical_node module – Manage Layer 3 Outside (L3Out) logical node profile nodes (l3ext:RsNodeL3OutAtt)

• aci_l3out_logical_node_profile module – Manage Layer 3 Outside (L3Out) logical node profiles (l3ext:LNodeP)

• aci_l3out_route_tag_policy module – Manage route tag policies (l3ext:RouteTagPol)

• aci_l3out_static_routes module – Manage Static routes object (l3ext:ipRouteP)

• aci_l3out_static_routes_nexthop module – Manage nexthops for static routes (ip:NexthopP)

• aci_maintenance_group module – This creates an ACI maintenance group (maint:MaintGrp)

• aci_maintenance_group_node module – Manage maintenance group nodes (fabric:NodeBlk)

• aci_maintenance_policy module – Manage firmware maintenance policies (maint:MaintP)

• aci_match_as_path_regex_term module – Manage Match Regular Expression AS-Path Term (rtctrl:MatchAsPathRegexTerm)

• aci_match_community_factor module – Manage Match Community Factor (rtctrl:MatchCommFactor)

• aci_match_community_regex_term module – Manage Match Regular Expression Community Term (rtctrl:MatchCommRegexTerm)

• aci_match_community_term module – Manage Match Community Term (rtctrl:MatchCommTerm)

• aci_match_route_destination module – Manage Match action rule term based on the Route Destination. (rtctrl:MatchRtDest)

• aci_match_rule module – Manage Match Rule (rtcrtl:SubjP)

• aci_node_mgmt_epg module – In band or Out of band management EPGs

• aci_ntp_policy module – Manage NTP policies.

• aci_ntp_server module – Manage NTP servers.

• aci_rest module – Direct access to the Cisco APIC REST API

• aci_route_control_context module – Manage Route Control Context (rtcrtl:CtxP)

• aci_route_control_profile module – Manage Route Control Profile (rtcrtl:Profile)

• aci_snmp_client module – Manage SNMP clients (snmp:ClientP).

• aci_snmp_client_group module – Manage SNMP client groups (snmp:ClientGrpP).

• aci_snmp_community_policy module – Manage SNMP community policies (snmp:CommunityP).

• aci_snmp_policy module – Manage Syslog groups (snmp:Pol).

• aci_snmp_user module – Manage SNMP v3 Users (snmp:UserP).

• aci_static_binding_to_epg module – Bind static paths to EPGs (fv:RsPathAtt)

• aci_static_node_mgmt_address module – In band or Out of band management IP address

• aci_switch_leaf_selector module – Bind leaf selectors to switch policy leaf profiles (infra:LeafS, infra:NodeBlk, infra:RsAccNodePGrep)

• aci_switch_policy_leaf_profile module – Manage switch policy leaf profiles (infra:NodeP)

• aci_switch_policy_vpc_protection_group module – Manage switch policy explicit vPC protection groups (fabric:ExplicitGEp, fabric:NodePEp).

• aci_syslog_group module – Manage Syslog groups (syslog:Group, syslog:Console, syslog:File and syslog:Prof).

• aci_syslog_remote_dest module – Manage Syslog Remote Destinations (syslog:RemoteDest).

• aci_syslog_source module – Manage Syslog Source objects (syslog:Src)

• aci_system module – Query the ACI system information (top:System)

• aci_system_banner module – Manages Alias and Banners (aaa:PreLoginBanner)

• aci_system_endpoint_controls module – Manage System Endpoint Controls (ep:IpAgingP, ep:ControlP, and ep:LoopProtectP)

• aci_system_global_aes_passphrase_encryption module – Manage Global AES Passphrase Encryption Settings (pki:ExportEncryptionKey)

• aci_taboo_contract module – Manage taboo contracts (vz:BrCP)

• aci_tag module – Tagging of ACI objects

• aci_tenant module – Manage tenants (fv:Tenant)

• aci_tenant_action_rule_profile module – Manage action rule profiles (rtctrl:AttrP)

• aci_tenant_ep_retention_policy module – Manage End Point (EP) retention protocol policies (fv:EpRetPol)

• aci_tenant_span_dst_group module – Manage SPAN destination groups (span:DestGrp)

• aci_tenant_span_src_group module – Manage SPAN source groups (span:SrcGrp)

• aci_tenant_span_src_group_src module – Manage SPAN source group sources (span:Src)

• aci_tenant_span_src_group_to_dst_group module – Bind SPAN source groups to destination groups (span:SpanLbl)

• aci_vlan_pool module – Manage VLAN pools (fvns:VlanInstP)

• aci_vlan_pool_encap_block module – Manage encap blocks assigned to VLAN pools (fvns:EncapBlk)

• aci_vmm_controller module – Manage VMM Controller for virtual domains profiles (vmm:CtrlrP)

• aci_vmm_credential module – Manage virtual domain credential profiles (vmm:UsrAccP)

• aci_vmm_uplink module – Manage VMM uplinks (vmm:UplinkP)

• aci_vmm_uplink_container module – Manage VMM uplink containers (vmm:UplinkPCont)

• aci_vmm_vswitch_policy module – Manage vSwitch policy for VMware virtual domains profiles (vmm:DomP)

• aci_vrf module – Manage contexts or VRFs (fv:Ctx)

• aci_vrf_leak_internal_subnet module – Manage VRF leaking of subnets (fv:leakInternalSubnet)

• aci_vzany_to_contract module – Attach contracts to vzAny (vz:RsAnyToProv, vz:RsAnyToCons, vz:RsAnyToConsIf)

Httpapi Plugins

• aci httpapi – Ansible ACI HTTPAPI Plugin.

Lookup Plugins

• interface_range lookup – query interfaces from a range or comma separated list of ranges

See also

List of collections with docs hosted here.