Spec-Zone.ru › Ansible

cisco.intersight.intersight_iscsi_boot_policy module – Управление политиками загрузки iSCSI для Cisco Intersight

Примечание

Этот модуль входит в коллекцию cisco.intersight (версия 2.18.0).

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

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

Чтобы использовать её в плейбуке, укажите: cisco.intersight.intersight_iscsi_boot_policy.

  • Краткое описание
  • Параметры
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Создание, обновление и удаление политик загрузки iSCSI в Cisco Intersight.
  • Политики загрузки iSCSI определяют, как серверы загружаются с целевых устройств iSCSI с использованием протоколов IPv4 или IPv6.
  • Поддерживается автоматическое обнаружение целевых устройств (Auto) и ручная настройка (Static) с источниками IP-адресов DHCP, Pool или Static.
  • Дополнительные сведения см. в документации Cisco Intersight.

Параметры

Параметр

Комментарии

api_key_id

строка / обязательно

Идентификатор открытого ключа API, связанного с закрытым ключом.

Если значение не задано, используется значение переменной среды INTERSIGHT_API_KEY_ID.

api_private_key

путь / обязательно

Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM, используемого для аутентификации в API Intersight.

Если используется строка, для её шифрования следует использовать Ansible Vault.

Например: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY-----

<your private key data>

-----END EC PRIVATE KEY-----’

Если значение не задано, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY.

api_uri

строка

URI для доступа к API Intersight.

Если значение не задано, используется значение переменной среды INTERSIGHT_API_URI.

По умолчанию: "https://intersight.com/api/v1"

auto_targetvendor_name

строка

Интерфейс автоматического обнаружения целевого устройства, представленный именем инициатора или идентификатором поставщика DHCP.

Идентификатор поставщика может содержать до 64 символов.

Обязателен, если target_source_type имеет значение auto, а iscsi_ip_type — ipv4.

chap

словарь

Параметры аутентификации CHAP для целевого устройства iSCSI.

Укажите user_id и password, чтобы включить аутентификацию CHAP.

Оставьте значение пустым или не указывайте параметр, чтобы отключить аутентификацию CHAP.

password

строка / обязательно

Пароль CHAP для аутентификации.

user_id

строка / обязательно

Имя пользователя CHAP для аутентификации.

description

псевдонимы: descr

строка

Описание политики загрузки iSCSI, заданное пользователем.

Описание может содержать буквы (a-z, A-Z), цифры (0-9), дефис (-), точку (.), двоеточие (:) или знак подчёркивания (_).

initiator_ip_pool_name

строка

Имя пула IP-адресов для назначения IP-адреса инициатору.

Обязателен, если initiator_ip_source имеет значение pool.

initiator_ip_source

строка

Способ назначения IP-адреса инициатору.

dhcp — автоматическое получение IP-адреса через DHCP.

pool — использование пула IP-адресов для назначения адреса.

static — ручная настройка статического IP-адреса.

Варианты:

  • "dhcp" ← (по умолчанию)
  • "pool"
  • "static"

initiator_static_ipv4_address

строка

Статический IPv4-адрес для инициатора iSCSI.

Обязателен, если initiator_ip_source имеет значение static, а iscsi_ip_type — ipv4.

initiator_static_ipv4_gateway

строка

IP-адрес шлюза IPv4 по умолчанию.

Обязателен, если initiator_ip_source имеет значение static, а iscsi_ip_type — ipv4.

initiator_static_ipv4_netmask

строка

Маска подсети — это 32-разрядное число, которое маскирует IP-адрес и разделяет его на сетевой адрес и адрес узла.

Обязателен, если initiator_ip_source имеет значение static, а iscsi_ip_type — ipv4.

initiator_static_ipv4_primary_dns

строка

IP-адрес основного сервера системы доменных имён (DNS).

Необязателен, если initiator_ip_source имеет значение static, а iscsi_ip_type — ipv4.

initiator_static_ipv4_secondary_dns

строка

IP-адрес дополнительного сервера системы доменных имён (DNS).

Необязателен, если initiator_ip_source имеет значение static, а iscsi_ip_type — ipv4.

initiator_static_ipv6_address

строка

Статический IPv6-адрес для инициатора iSCSI.

Обязателен, если initiator_ip_source имеет значение static, а iscsi_ip_type — ipv6.

initiator_static_ipv6_gateway

строка

IP-адрес шлюза IPv6 по умолчанию.

Обязателен, если initiator_ip_source имеет значение static, а iscsi_ip_type — ipv6.

initiator_static_ipv6_prefix

целое число

Длина префикса в виде целого числа, который маскирует IP-адрес и разделяет его на сетевой адрес и адрес узла.

Обязателен, если initiator_ip_source имеет значение static, а iscsi_ip_type — ipv6.

iscsi_adapter_policy_name

строка

Связь с политикой адаптера iSCSI.

Имя политики адаптера iSCSI, связываемой с этой политикой загрузки.

Необязателен для всех конфигураций.

iscsi_ip_type

строка

Тип IP-адреса, запрашиваемого для vNIC iSCSI: IPv4/IPv6.

ipv4 поддерживает автоматический и статический типы источника целевого устройства.

ipv6 поддерживает только статический тип источника целевого устройства (не auto).

Для ipv4 и ipv6 поддерживаются источники IP-адресов инициатора dhcp, pool и static.

Варианты:

  • "ipv4" ← (по умолчанию)
  • "ipv6"

mutual_chap

словарь

Параметры взаимной аутентификации CHAP для инициатора iSCSI.

Двусторонний механизм CHAP.

Укажите user_id и password, чтобы включить взаимную аутентификацию CHAP.

Оставьте значение пустым или не указывайте параметр, чтобы отключить взаимную аутентификацию CHAP.

password

строка / обязательно

Пароль взаимной аутентификации CHAP.

user_id

строка / обязательно

Имя пользователя взаимной аутентификации CHAP.

name

строка / обязательно

Имя, присвоенное политике загрузки iSCSI.

Имя должно быть уникальным в пределах организации.

Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.

organization

строка

Имя организации, которой назначен этот ресурс.

Политики, созданные в пользовательской организации, применимы только к устройствам в той же организации.

Для организации по умолчанию используйте ‘default’.

По умолчанию: "default"

primary_target_policy_name

строка

Задает сведения о профиле целевого устройства для загрузки iSCSI.

Имя основной политики статического целевого устройства iSCSI.

Обязателен, если target_source_type имеет значение static.

secondary_target_policy_name

строка

Задает сведения о профиле целевого устройства для загрузки iSCSI.

Необязателен, если target_source_type имеет значение static.

state

строка

Если задано значение present, модуль проверит наличие ресурса и при необходимости создаст его.

Если задано значение absent, модуль проверит отсутствие ресурса и при необходимости удалит его.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

список / элементы=словарь

Список тегов в формате «Ключ:<ключ, заданный пользователем> Значение:<значение, заданное пользователем>».

target_source_type

строка

Способ обнаружения целевого устройства.

auto — автоматическое обнаружение целевого устройства с использованием идентификатора поставщика DHCP/IQN.

static — ручная настройка целевого устройства с использованием политик целевых устройств.

Варианты:

  • "auto"
  • "static" ← (по умолчанию)

use_proxy

логическое значение

Если задано значение no, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах.

Варианты:

  • false
  • true ← (по умолчанию)

validate_certs

логическое значение

Управляет проверкой TLS-сертификата api_uri.

Варианты:

  • false
  • true ← (по умолчанию)

Примеры

- name: Create iSCSI Boot Policy with Auto discovery (IPv4)
  cisco.intersight.intersight_iscsi_boot_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "iscsi-boot-auto"
    description: "iSCSI boot policy with auto discovery"
    iscsi_ip_type: "ipv4"
    target_source_type: "auto"
    auto_targetvendor_name: "iqn.1991-05.com.cisco"
    iscsi_adapter_policy_name: "iscsi-adapter-policy"
    initiator_ip_source: "dhcp"
    state: present

- name: Create iSCSI Boot Policy with Static targets and DHCP initiator (IPv4)
  cisco.intersight.intersight_iscsi_boot_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "iscsi-boot-static-dhcp"
    description: "iSCSI boot policy with static targets"
    iscsi_ip_type: "ipv4"
    target_source_type: "static"
    primary_target_policy_name: "primary-target-policy"
    secondary_target_policy_name: "secondary-target-policy"
    chap:
      user_id: "chapuser"
      password: "chappassword123"
    mutual_chap:
      user_id: "mutualuser"
      password: "mutualpassword123"
    initiator_ip_source: "dhcp"
    state: present

- name: Create iSCSI Boot Policy with Pool-based initiator IP
  cisco.intersight.intersight_iscsi_boot_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "iscsi-boot-pool"
    description: "iSCSI boot policy with IP pool"
    iscsi_ip_type: "ipv4"
    target_source_type: "static"
    primary_target_policy_name: "primary-target-policy"
    initiator_ip_source: "pool"
    initiator_ip_pool_name: "iscsi-ip-pool"
    state: present

- name: Create iSCSI Boot Policy with Static IPv4 configuration
  cisco.intersight.intersight_iscsi_boot_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "iscsi-boot-static-ipv4"
    description: "iSCSI boot policy with static IPv4"
    iscsi_ip_type: "ipv4"
    target_source_type: "static"
    primary_target_policy_name: "primary-target-policy"
    initiator_ip_source: "static"
    initiator_static_ipv4_address: "192.168.1.100"
    initiator_static_ipv4_netmask: "255.255.255.0"
    initiator_static_ipv4_gateway: "192.168.1.1"
    initiator_static_ipv4_primary_dns: "8.8.8.8"
    initiator_static_ipv4_secondary_dns: "8.8.4.4"
    tags:
      - Key: Environment
        Value: Production
    state: present

- name: Create iSCSI Boot Policy with Static IPv6 configuration
  cisco.intersight.intersight_iscsi_boot_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "iscsi-boot-static-ipv6"
    description: "iSCSI boot policy with static IPv6"
    iscsi_ip_type: "ipv6"
    target_source_type: "static"
    primary_target_policy_name: "primary-target-policy-ipv6"
    initiator_ip_source: "static"
    initiator_static_ipv6_address: "2001:db8::1"
    initiator_static_ipv6_prefix: 64
    initiator_static_ipv6_gateway: "2001:db8::ffff"
    state: present

- name: Create iSCSI Boot Policy with IPv6 DHCP initiator
  cisco.intersight.intersight_iscsi_boot_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "iscsi-boot-ipv6-dhcp"
    description: "iSCSI boot policy with IPv6 DHCP"
    iscsi_ip_type: "ipv6"
    target_source_type: "static"
    primary_target_policy_name: "primary-target-policy-ipv6"
    initiator_ip_source: "dhcp"
    state: present

- name: Create iSCSI Boot Policy with IPv6 Pool initiator
  cisco.intersight.intersight_iscsi_boot_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "iscsi-boot-ipv6-pool"
    description: "iSCSI boot policy with IPv6 pool"
    iscsi_ip_type: "ipv6"
    target_source_type: "static"
    primary_target_policy_name: "primary-target-policy-ipv6"
    initiator_ip_source: "pool"
    initiator_ip_pool_name: "ipv6-ip-pool"
    state: present

- name: Delete iSCSI Boot Policy
  cisco.intersight.intersight_iscsi_boot_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "iscsi-boot-auto"
    state: absent

Возвращаемые значения

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

Ключ

Описание

api_response

словарь

Выходные данные ответа API, возвращённые указанным ресурсом.

Возвращается: всегда

Пример: {"api_response": {"AutoTargetvendorName": "iqn.1991-05.com.cisco", "InitiatorIpSource": "DHCP", "IscsiIpType": "IPv4", "Moid": "1234567890abcdef12345678", "Name": "iscsi-boot-auto", "ObjectType": "vnic.IscsiBootPolicy", "Tags": [{"Key": "Environment", "Value": "Production"}], "TargetSourceType": "Auto"}}

Авторы

  • Ron Gershburg (@rgershbu)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API