Модуль cisco.aci.aci_fabric_management_access – Управление доступом к управлению тканью (comm:Pol)

Примечание

Этот модуль является частью коллекции cisco.aci (версия 2.10.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.aci.

Для использования в playbook укажите: cisco.aci.aci_fabric_management_access.

Обзор
Параметры
См. также
Примеры
Возвращаемые значения

Обзор

Управление доступом к управлению тканью на тканях Cisco ACI.

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. Default: `"orchestrator:ansible"`
certificate_name aliases: cert_name string	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `private_key`, значение по умолчанию будет базовым именем `private_key`, без расширения. Если для `private_key` предоставлено содержимое в формате PEM, значение по умолчанию будет `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description aliases: descr string	Описание политики доступа к управлению Fabric.
host aliases: hostname string	IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
http dictionary	Параметры для конфигурации HTTP (comm:Http).
admin_state string	Административное состояние соединения HTTP. APIC использует значение по умолчанию `disabled` при создании, если значение не задано. Choices: `"enabled"` `"disabled"`
allow_credentials string	Состояние разрешения учетных данных для соединения HTTP. APIC использует значение по умолчанию `disabled` при создании, если значение не задано. Choices: `"enabled"` `"disabled"`
allow_origins string	Разрешённые источники для соединения HTTP. Пример формата: http://127.0.0.1:8000
port integer	Порт для соединения HTTP. APIC использует значение по умолчанию `80` при создании, если значение не задано.
redirect string	Состояние службы перенаправления HTTP на HTTPS. APIC использует значение по умолчанию `disabled` при создании, если значение не задано. Choices: `"enabled"` `"disabled"` `"tested"`
throttle string	Состояние ограничения запросов для соединения HTTP. APIC использует значение по умолчанию `disabled` при создании, если значение не задано. Choices: `"enabled"` `"disabled"`
throttle_rate integer	Скорость ограничения запросов. APIC использует значение по умолчанию `10000` при создании, если значение не задано.
throttle_unit string	Единица измерения скорости ограничения запросов. APIC использует значение по умолчанию `requests_per_second` при создании, если значение не задано. Choices: `"requests_per_second"` `"requests_per_minute"`
https dictionary	Параметры для конфигурации HTTPS (comm:Https).
admin_key_ring string	Административное кольцо ключей для соединения HTTPS. APIC использует значение по умолчанию `default` при создании, если значение не задано.
admin_state string	Административное состояние соединения HTTPS. APIC использует значение по умолчанию `enabled` при создании, если значение не задано. Choices: `"enabled"` `"disabled"`
allow_credentials string	Состояние разрешения учетных данных для соединения HTTPS. APIC использует значение по умолчанию `disabled` при создании, если значение не задано. Choices: `"enabled"` `"disabled"`
allow_origins string	Разрешённые источники для соединения HTTPS. Пример формата: http://127.0.0.1:8000

client_certificate_authentication_state aliases: client_certificate_auth_state, auth_state, authentication_state string	Состояние проверки подлинности клиента по сертификату для HTTPS-соединения. Значение по умолчанию APIC — `disabled`, если не указано при создании. Состояние `enabled` требует установки `client_certificate_trustpoint`. Варианты: `"enabled"` `"disabled"`
client_certificate_trustpoint aliases: trustpoint string	Точка доверия для сертификата клиента HTTPS-соединения.
dh_param string	Параметр Diffie-Hellman для HTTPS-соединения. Значение по умолчанию APIC — `none`, если не указано при создании. Варианты: `"1024"` `"2048"` `"4096"` `"none"`
port integer	Порт для HTTPS-соединения. Значение по умолчанию APIC — `443` при создании.
ssl aliases: ssl_protocols list / elements=string	Протокол(ы) SSL для HTTPS-соединения. APIC по умолчанию устанавливает `tls_v1.1` и `tls_v1.2`, если значения не указаны при создании. Варианты: `"tls_v1.0"` `"tls_v1.1"` `"tls_v1.2"` `"tls_v1.3"`
throttle string	Состояние ограничения запросов для HTTPS-соединения. Значение по умолчанию APIC — `disabled` при создании. Варианты: `"enabled"` `"disabled"`
throttle_rate integer	Скорость ограничения запросов. Значение по умолчанию APIC — `10000` при создании.
throttle_unit string	Единица измерения скорости ограничения запросов. Значение по умолчанию APIC — `requests_per_second` при создании. Варианты: `"requests_per_second"` `"requests_per_minute"`
name aliases: fabric_management_access_policy_name string	Имя политики доступа к управлению Fabric.
name_alias string	Псевдоним имени политики доступа к управлению Fabric. Относится к свойству nameAlias в ACI.
output_level string	Влияет на вывод этого модуля ACI. `normal` — стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path string	Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_PATH`.
owner_key string	Определяемая пользователем строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ для предоставления клиентам права собственности на данные для корреляции сущностей. Если значение не указано в задаче, используется значение переменной среды `ACI_OWNER_KEY`.
owner_tag string	Определяемая пользователем строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, который позволяет клиентам добавлять свои собственные данные. Например, для указания, кто создал этот объект. Если значение не указано в задаче, используется значение переменной среды `ACI_OWNER_TAG`.
password string	Пароль для аутентификации. Этот параметр взаимно исключает `private_key`. Если также предоставлен `private_key`, будет использоваться он. Если значение не указано в задаче, используются значения переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной среды `ACI_PORT`.

private_key aliases: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name` , которое используется. Эта опция взаимоисключающая с `password`. Если `password` также предоставлено, оно будет игнорироваться. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
ssh dictionary	Параметры для конфигурации SSH (comm:Ssh).
admin_state string	Административное состояние соединения SSH. APIC по умолчанию использует `enabled` , если значение не задано при создании. Варианты: `"enabled"` `"disabled"`
ciphers list / elements=string	Шифры соединения SSH. APIC по умолчанию использует все заданные параметры, если значение не задано при создании. Варианты: `"aes128_ctr"` `"aes192_ctr"` `"aes256_ctr"` `"aes128_gcm"` `"aes256_gcm"` `"chacha20"`
kex list / elements=string	Алгоритмы KEX соединения SSH. APIC по умолчанию использует все заданные параметры, если значение не задано при создании. Варианты: `"dh_sha1"` `"dh_sha256"` `"dh_sha512"` `"curve_sha256"` `"curve_sha256_libssh"` `"ecdh_256"` `"ecdh_384"` `"ecdh_521"`
macs list / elements=string	MAC-адреса соединения SSH. APIC по умолчанию использует все заданные параметры, если значение не задано при создании. Варианты: `"sha1"` `"sha2_256"` `"sha2_512"` `"sha2_256_etm"` `"sha2_512_etm"`
password_auth_state string	Состояние аутентификации паролем соединения SSH. APIC по умолчанию использует `enabled` , если значение не задано при создании. Варианты: `"enabled"` `"disabled"`
port integer	Порт для соединения SSH. APIC по умолчанию использует `22` , если значение не задано при создании.
ssh_web dictionary	Параметры для доступа SSH через веб-конфигурацию (comm:Shellinabox).
admin_state string	Административное состояние доступа SSH через веб-соединение. APIC по умолчанию использует `disabled` , если значение не задано при создании. Варианты: `"enabled"` `"disabled"`
state string	Используйте `present` для обновления конфигурации. Используйте `query` для отображения текущей конфигурации. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous aliases: no_previous, ignore_previous boolean	Если `true`, запрос GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, проверочный запрос GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, будет непроверяемым в одной задаче. Варианты: `false` `true`
telnet dictionary	Параметры для конфигурации telnet (comm:Telnet).
admin_state string	Административное состояние соединения telnet. APIC по умолчанию использует `disabled` , если значение не задано при создании. Варианты: `"enabled"` `"disabled"`

порт целое число	Порт для подключения по Telnet. APIC по умолчанию использует `23`, если значение не задано при создании.
таймаут целое число	Таймаут на уровне сокета в секундах. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию равно 30.
использовать_прокси логическое значение	Если `false`, прокси не будет использоваться, даже если оно определено в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
использовать_ssl логическое значение	Если `false`, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_USE_SSL`. Значение по умолчанию — true при локальном подключении. Варианты: `false` `true`
имя_пользователя псевдонимы: пользователь строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него используются значения переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
проверять_сертификаты логическое значение	Если `false`, сертификаты SSL не будут проверены. Это следует устанавливать в `false` только при работе с сайтами, контролируемыми лично, использующими самозаверяющие сертификаты. Если значение не указано в задаче, вместо него используется значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

См. также

Справочник по модели информации управления APIC: Дополнительная информация о внутренней внутренней модели APIC comm:Pol.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- 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

Значения возврата

Общие значения возврата задокументированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
current список / элементы=строка	Существующая конфигурация с APIC после завершения модуля Возвращено: успех Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error словарь	Информация об ошибке, возвращенная с APIC Возвращено: неудача Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string строка	Используемая строка фильтра для запроса Возвращено: неудача или отладка Пример: `"?rsp-prop-include=config-only"`
method строка	HTTP-метод, используемый для запроса к APIC Возвращено: неудача или отладка Пример: `"POST"`
previous список / элементы=строка	Исходная конфигурация с APIC до запуска модуля Возвращено: информация Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed словарь	Собраная конфигурация из предоставленных пользователем параметров Возвращено: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw строка	Необработанный вывод, возвращенный API REST APIC (xml или json) Возвращено: ошибка разбора Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response строка	HTTP-ответ от APIC Возвращено: неудача или отладка Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, отправленная в APIC Возвращено: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	HTTP-статус с APIC Возвращено: неудача или отладка Пример: `200`
url строка	Используемый HTTP-URL для запроса к APIC Возвращено: неудача или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Akini Ross (@akinross)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_fabric_management_access_module.html