cisco.aci.aci_fabric_management_access module – Manage Fabric Management Access (comm:Pol)

Note

This module is part of the cisco.aci collection (version 2.12.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.aci.

To use it in a playbook, specify: cisco.aci.aci_fabric_management_access.

Synopsis

• Manage Fabric Management Access on Cisco ACI fabrics.

Parameters

Parameter	Comments
annotation string	User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead. If the value is not specified in the task and environment variable ACI_ANNOTATION then the default value will be used. Default: "orchestrator:ansible"
certificate_name aliases: cert_name string	The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a private_key filename was provided, this defaults to the private_key basename, without extension. If PEM-formatted content was provided for private_key, this defaults to the username value. If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.
description aliases: descr string	The description of the Fabric Management Access policy.
host aliases: hostname string	IP Address or hostname of APIC resolvable by Ansible control host. If the value is not specified in the task, the value of environment variable ACI_HOST will be used instead.
http dictionary	Parameters for HTTP configuration (comm:Http).
admin_state string	The admin state of the HTTP connection. The APIC defaults to disabled when unset during creation. Choices: "enabled" "disabled"
allow_credentials string	The state of the allow credential for the HTTP connection. The APIC defaults to disabled when unset during creation. Choices: "enabled" "disabled"
allow_origins string	The allowed origins for the HTTP connection. Example format: http://127.0.0.1:8000
port integer	The port for the HTTP connection. The APIC defaults to 80 when unset during creation.
redirect string	The state of the HTTP to HTTPS redirect service. The APIC defaults to disabled when unset during creation. Choices: "enabled" "disabled" "tested"
throttle string	The state of the request throttle for the HTTP connection. The APIC defaults to disabled when unset during creation. Choices: "enabled" "disabled"
throttle_rate integer	The rate of the request throttle. The APIC defaults to 10000 when unset during creation.
throttle_unit string	The unit of the request throttle rate. The APIC defaults to requests_per_second when unset during creation. Choices: "requests_per_second" "requests_per_minute"
https dictionary	Parameters for HTTPS configuration (comm:Https).
admin_key_ring string	The admin key ring for the HTTPS connection. The APIC defaults to default when unset during creation.
admin_state string	The admin state of the HTTPS connection. The APIC defaults to enabled when unset during creation. Choices: "enabled" "disabled"
allow_credentials string	The state of the allow credential for the HTTPS connection. The APIC defaults to disabled when unset during creation. Choices: "enabled" "disabled"
allow_origins string	The allowed origins for the HTTPS connection. Example format: http://127.0.0.1:8000
client_certificate_authentication_state aliases: client_certificate_auth_state, auth_state, authentication_state string	The client certificate authentication state for the HTTPS connection. The APIC defaults to disabled when unset during creation. The enabled state requires a client_certificate_trustpoint to be set. Choices: "enabled" "disabled"
client_certificate_trustpoint aliases: trustpoint string	The client certificate trustpoint for the HTTPS connection.
dh_param string	The Diffie-Hellman parameter for the HTTPS connection. The APIC defaults to none when unset during creation. Choices: "1024" "2048" "4096" "none"
port integer	The port for the HTTPS connection. The APIC defaults to 443 when unset during creation.
ssl aliases: ssl_protocols list / elements=string	The SSL protocol(s) for the HTTPS connection. The APIC defaults to tls_v1.1 and tls_v1.2 set when unset during creation. Choices: "tls_v1.0" "tls_v1.1" "tls_v1.2" "tls_v1.3"
throttle string	The state of the request throttle for the HTTPS connection. The APIC defaults to disabled when unset during creation. Choices: "enabled" "disabled"
throttle_rate integer	The rate of the request throttle. The APIC defaults to 10000 when unset during creation.
throttle_unit string	The unit of the request throttle rate. The APIC defaults to requests_per_second when unset during creation. Choices: "requests_per_second" "requests_per_minute"
name aliases: fabric_management_access_policy_name string	The name of the Fabric Management Access policy.
name_alias string	The name alias of the Fabric Management Access policy. This relates to the nameAlias property in ACI.
output_level string	Influence the output of this ACI module. normal means the standard output, incl. current dict info adds informational output, incl. previous, proposed and sent dicts debug adds debugging output, incl. filter_string, method, response, status and url information If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead. Choices: "debug" "info" "normal" ← (default)
output_path string	Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. If the value is not specified in the task, the value of environment variable ACI_OUTPUT_PATH will be used instead.
owner_key string	User-defined string for the ownerKey attribute of an ACI object. This attribute represents a key for enabling clients to own their data for entity correlation. If the value is not specified in the task, the value of environment variable ACI_OWNER_KEY will be used instead.
owner_tag string	User-defined string for the ownerTag attribute of an ACI object. This attribute represents a tag for enabling clients to add their own data. For example, to indicate who created this object. If the value is not specified in the task, the value of environment variable ACI_OWNER_TAG will be used instead.
password string	The password to use for authentication. This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
port integer	Port number to be used for REST connection. The default value depends on parameter use_ssl. If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.
private_key aliases: cert_key string	Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default certificate_name that is used. This option is mutual exclusive with password. If password is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY or ANSIBLE_NET_SSH_KEYFILE will be used instead.
ssh dictionary	Parameters for SSH configuration (comm:Ssh).
admin_state string	The admin state of the SSH connection. The APIC defaults to enabled when unset during creation. Choices: "enabled" "disabled"
ciphers list / elements=string	The ciphers of the SSH connection. The APIC defaults to all options set when unset during creation. Choices: "aes128_ctr" "aes192_ctr" "aes256_ctr" "aes128_gcm" "aes256_gcm" "chacha20"
kex list / elements=string	The KEX algorithms of the SSH connection. The APIC defaults to all options set when unset during creation. Choices: "dh_sha1" "dh_sha256" "dh_sha512" "curve_sha256" "curve_sha256_libssh" "ecdh_256" "ecdh_384" "ecdh_521"
macs list / elements=string	The MACs of the SSH connection. The APIC defaults to all options set when unset during creation. Choices: "sha1" "sha2_256" "sha2_512" "sha2_256_etm" "sha2_512_etm"
password_auth_state string	The password authentication state of the SSH connection. The APIC defaults to enabled when unset during creation. Choices: "enabled" "disabled"
port integer	The port for the SSH connection. The APIC defaults to 22 when unset during creation.
ssh_web dictionary	Parameters for SSH access via WEB configuration (comm:Shellinabox).
admin_state string	The admin state of the SSH access via WEB connection. The APIC defaults to disabled when unset during creation. Choices: "enabled" "disabled"
state string	Use present for updating configuration. Use query for showing current configuration. Choices: "absent" "present" ← (default) "query"
suppress_previous aliases: no_previous, ignore_previous boolean	If true, a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable ACI_SUPPRESS_PREVIOUS will be used instead. The default value is false. WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. Choices: false true
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	If true, a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable ACI_SUPPRESS_VERIFICATION will be used instead. The default value is false. WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. Choices: false true
telnet dictionary	Parameters for telnet configuration (comm:Telnet).
admin_state string	The admin state of the telnet connection. The APIC defaults to disabled when unset during creation. Choices: "enabled" "disabled"
port integer	The port for the telnet connection. The APIC defaults to 23 when unset during creation.
timeout integer	The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead. The default value is 30.
use_proxy boolean	If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable ACI_USE_PROXY will be used instead. The default value is true. Choices: false true
use_ssl boolean	If false, an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable ACI_USE_SSL will be used instead. The default value is true when the connection is local. Choices: false true
username aliases: user string	The username to use for authentication. If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead. The default value is admin.
validate_certs boolean	If false, SSL certificates will not be validated. This should only set to false when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable ACI_VALIDATE_CERTS will be used instead. The default value is true. Choices: false true

See Also

See also

APIC Management Information Model reference

More information about the internal APIC class comm:Pol.

Cisco ACI Guide

Detailed information on how to manage your ACI infrastructure using Ansible.

Developing Cisco ACI modules

Detailed guide on how to write your own Cisco ACI modules to contribute.

Examples

- name: Create a Fabric Management Access policy
  cisco.aci.aci_fabric_management_access:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabric_management_access_policy_1
    description: "This is a example Fabric Management Access policy."
    state: present
  delegate_to: localhost

- name: Create a Fabric Management Access policy with telnet enabled
  cisco.aci.aci_fabric_management_access:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabric_management_access_policy_1
    description: "This is a example Fabric Management Access policy."
    telnet:
      admin_state: enabled
    state: present
  delegate_to: localhost

- name: Create a Fabric Management Access policy with SSH access via WEB enabled
  cisco.aci.aci_fabric_management_access:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabric_management_access_policy_1
    description: "This is a example Fabric Management Access policy."
    ssh_web:
      admin_state: enabled
    state: present
  delegate_to: localhost

- name: Create a Fabric Management Access policy with SSH enabled and ciphers set
  cisco.aci.aci_fabric_management_access:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabric_management_access_policy_1
    description: "This is a example Fabric Management Access policy."
    ssh:
      admin_state: enabled
      ciphers:
        - aes128_ctr
        - aes192_ctr
        - aes256_ctr
    state: present
  delegate_to: localhost

- name: Create a Fabric Management Access policy with HTTP enabled
  cisco.aci.aci_fabric_management_access:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabric_management_access_policy_1
    description: "This is a example Fabric Management Access policy."
    http:
      admin_state: enabled
      allow_origins: http://127.0.0.1:8000
      throttle: enabled
      throttle_rate: 7500
      throttle_unit: requests_per_minute
    state: present
  delegate_to: localhost

- name: Create a Fabric Management Access policy with HTTPS enabled
  cisco.aci.aci_fabric_management_access:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabric_management_access_policy_1
    description: "This is a example Fabric Management Access policy."
    https:
      admin_state: enabled
      port: 445
      allow_origins: http://127.0.0.1:8000
      allow_credentials: enabled
      ssl:
        - tls_v1.2
      dh_param: 4096
      throttle: enabled
      throttle_rate: 7500
      throttle_unit: requests_per_minute
      admin_key_ring: default
      client_certificate_trustpoint: ansible_trustpoint
      client_certificate_authentication_state: enabled
    state: present
  delegate_to: localhost

- name: Query a Fabric Management Access policy
  cisco.aci.aci_fabric_management_access:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabric_management_access_policy_1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric Management Access policies
  cisco.aci.aci_fabric_management_access:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a Fabric Management Access policy
  cisco.aci.aci_fabric_management_access:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabric_management_access_policy_1
    state: absent
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
current list / elements=string	The existing configuration from the APIC after the module has finished Returned: success Sample: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error dictionary	The error information as returned from the APIC Returned: failure Sample: {"code": "122", "text": "unknown managed object class foo"}
filter_string string	The filter string used for the request Returned: failure or debug Sample: "?rsp-prop-include=config-only"
method string	The HTTP method used for the request to the APIC Returned: failure or debug Sample: "POST"
previous list / elements=string	The original configuration from the APIC before the module has started Returned: info Sample: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed dictionary	The assembled configuration from the user-provided parameters Returned: info Sample: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw string	The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
response string	The HTTP response from the APIC Returned: failure or debug Sample: "OK (30 bytes)"
sent list / elements=string	The actual/minimal configuration pushed to the APIC Returned: info Sample: {"fvTenant": {"attributes": {"descr": "Production environment"}}}
status integer	The HTTP status from the APIC Returned: failure or debug Sample: 200
url string	The HTTP url used for the request to the APIC Returned: failure or debug Sample: "https://10.11.12.13/api/mo/uni/tn-production.json"

Authors

• Akini Ross (@akinross)

Collection links

• Issue Tracker
• Repository (Sources)