Модуль cisco.aci.aci_key_policy — Управление политикой ключей (fv:KeyPol)

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install cisco.aci.

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

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

Обзор

Управление политиками ключей для политик цепочек ключей на Cisco ACI фабриках.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, используется значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, используется значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен имя файла `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен PEM-формат содержимого, по умолчанию используется значение `username`. Если значение не указано в задаче, используется значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание политики ключа.
end_time строка	Конечное время действия политики ключа. APIC по умолчанию устанавливает `infinite`, если это значение не задано во время создания. Формат - ГГГГ-ММ-ДД ЧЧ:ММ:СС
host псевдонимы: hostname строка	IP-адрес или имя хоста, разрешаемое хостом Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`.
id целое число	Идентификатор объекта.
keychain_policy псевдонимы: keychain_policy_name строка	Имя существующей политики ключа.
output_level строка	Влияет на вывод данного модуля ACI. `normal` — стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, который будет использоваться для вывода конфигурационных объектов ACI в формате JSON, сгенерированных модулем. Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_PATH`.
owner_key строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, используется значение переменной среды `ACI_OWNER_KEY`.
owner_tag строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять свои собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, используется значение переменной среды `ACI_OWNER_TAG`.
password строка	Пароль для аутентификации. Этот параметр является взаимоисключающим с `private_key`. Если указан `private_key`, он будет использован вместо данного параметра. Если значение не указано в задаче, используется значение переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной среды `ACI_PORT`.
pre_shared_key строка	Предварительно заданный ключ аутентификации. При использовании pre_shared_key данный модуль всегда будет отображаться как `changed`, так как модуль не может знать, какой ключ настроен в настоящее время.
private_key псевдонимы: cert_key строка	Файл приватного ключа в формате PEM или содержимое приватного ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр является взаимоисключающим с `password`. Если указан `password`, он будет проигнорирован. Если значение не указано в задаче, используется значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
start_time строка	Начальное время действия политики ключа. APIC по умолчанию устанавливает `now`, если это значение не задано во время создания. Формат - ГГГГ-ММ-ДД ЧЧ:ММ:СС

state string	Использовать `present` или `absent` для добавления или удаления. Использовать `query` для получения списка объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous boolean	Если `true`, GET-запрос для проверки предыдущего состояния не будет отправлен перед обновлением POST на APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, проверка GET не будет отправлена после обновления POST на APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче. Варианты: `false` `true`
tenant псевдонимы: tenant_name string	Имя существующего арендатора.
timeout целое число	Тайм-аут уровня сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию true. Варианты: `false` `true`
use_ssl boolean	Если `false`, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_SSL`. Значение по умолчанию true, когда соединение локальное. Варианты: `false` `true`
username псевдонимы: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это должно быть установлено в `false` только при использовании на управляемых сайтах с использованием самозаверяющих сертификатов. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию true. Варианты: `false` `true`

Примечания

Примечание

tenant и keychain_policy должны существовать перед использованием данного модуля в вашем плейбуке. Для этого можно использовать cisco.aci.aci_tenant и cisco.aci.aci_keychain_policy.

См. также

cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
cisco.aci.aci_keychain_policy: Управление политикой KeyChain (fv:KeyChainPol).
Ссылка на справочник модели управления информацией APIC: Дополнительная информация о внутренних классах APIC
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой Cisco ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для участия.

Примеры

- name: Add a new key policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    id: 1
    start_time: now
    end_time: infinite
    pre_shared_key: my_password
    state: present
  delegate_to: localhost

- name: Delete an key policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    id: 1
    state: absent
  delegate_to: localhost

- name: Query an key policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    id: 1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all key policies in my_keychain_policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Описание
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 строка	Необработанный вывод, возвращённый APIC REST API (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"`

Авторы

Gaspard Micol (@gmicol)

Ссылки на сборку

© 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_key_policy_module.html