Spec-Zone.ru › Ansible

модуль cisco.intersight.intersight_ip_pool — настройка пула IP-адресов для Cisco Intersight

Примечание

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

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

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

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

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

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

  • Настройка пула IP-адресов для Cisco Intersight.
  • Используется для настройки параметров пулов IP-адресов на устройствах, управляемых Cisco Intersight.
  • Дополнительные сведения см. в документации Cisco Intersight.

Параметры

Параметр

Комментарии

api_key_id

string / обязательный

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

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

api_private_key

path / обязательный

Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате 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

string

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

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

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

assignment_order

string

Порядок назначения определяет, в какой последовательности выделяется следующий идентификатор.

Если задано sequential, идентификаторы назначаются последовательно.

Если задано default, порядок назначения определяется системой.

Варианты:

  • "default" ← (по умолчанию)
  • "sequential"

description

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

string

Описание пула IP-адресов, заданное пользователем.

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

enable_block_level_subnet_config

boolean

Определяет, задаются ли параметры “Netmask”, “Gateway”, “PrimaryDns” и “SecondaryDns” глобально или отдельно для каждого блока IPv4.

Определяет, задаются ли параметры “Prefix”, “Gateway”, “PrimaryDns” и “SecondaryDns” глобально или отдельно для каждого блока IPv6.

Варианты:

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

ipv4_blocks

list / элементы=dictionary

Список блоков IPv4.

Если параметр “enable_block_level_subnet_config” имеет значение true, для каждого блока необходимо указать сведения ipv4_config.

from

string

Первый IPv4-адрес блока.

ipv4_config

dictionary

Определение параметров IPv4 “Netmask”, “Gateway”, “PrimaryDns” и “SecondaryDns” для блока.

Используется только при значении true параметра “enable_block_level_subnet_config”; в противном случае параметры следует задать глобально.

gateway

string

IP-адрес шлюза для текущего блока IPv4.

netmask

string

Маска подсети для текущего блока IPv4.

primary_dns

string

IP-адрес PrimaryDns для текущего блока IPv4.

secondary_dns

string

IP-адрес SecondaryDns для текущего блока IPv4.

size

integer

Количество идентификаторов, которое может содержать этот блок.

ipv4_config

dictionary

Глобальное определение параметров IPv4 “Netmask”, “Gateway”, “PrimaryDns” и “SecondaryDns”.

Используется только при значении false параметра “enable_block_level_subnet_config”; в противном случае параметры следует задать внутри ipv4_blocks.

gateway

string

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

IP-адрес шлюза для всех блоков IPv4.

netmask

string

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

Маска подсети для всех блоков IPv4.

primary_dns

string

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

IP-адрес PrimaryDns для всех блоков IPv4.

secondary_dns

string

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

IP-адрес SecondaryDns для всех блоков IPv4.

ipv6_blocks

list / элементы=dictionary

Определение блоков IPv6.

Если параметр “enable_block_level_subnet_config” имеет значение true, для каждого блока необходимо указать сведения ipv6_config.

from

string

Начальный IP-адрес блока IPv6.

ipv6_config

dictionary

Определение параметров IPv6 “Prefix”, “Gateway”, “PrimaryDns” и “SecondaryDns” для блока.

Используется только при значении true параметра “enable_block_level_subnet_config”; в противном случае параметры следует задать глобально.

gateway

string

IP-адрес шлюза для текущего блока IPv6.

prefix

integer

Префикс для текущего блока IPv6.

primary_dns

string

IP-адрес PrimaryDns для текущего блока IPv6.

secondary_dns

string

IP-адрес SecondaryDns для текущего блока IPv6.

size

integer

Количество IP-адресов в блоке.

ipv6_config

dictionary

Глобальное определение параметров IPv6 “Prefix”, “Gateway”, “PrimaryDns” и “SecondaryDns”.

Используется только при значении false параметра “enable_block_level_subnet_config”; в противном случае параметры следует задать внутри ipv6_blocks.

gateway

string

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

IP-адрес шлюза для всех блоков IPv6.

prefix

string

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

Префикс для всех блоков IPv6.

primary_dns

string

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

IP-адрес PrimaryDns для всех блоков IPv6.

secondary_dns

string

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

IP-адрес SecondaryDns для всех блоков IPv6.

name

string / обязательный

Имя, присвоенное пулу IP-адресов.

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

organization

string

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

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

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

state

string

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

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

Варианты:

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

tags

list / элементы=dictionary

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

use_proxy

boolean

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

Варианты:

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

validate_certs

boolean

Логическое значение, управляющее проверкой TLS-сертификата api_uri

Варианты:

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

Примеры

- name: Configure IP Pool with global config
  cisco.intersight.intersight_ip_pool:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-ip-pool
    description: IP Pool for lab use
    assignment_order: sequential
    ipv4_config:
      netmask: "255.255.255.0"
      gateway: "172.17.116.1"
      primary_dns: "172.17.116.2"
      secondary_dns: "172.17.116.3"
    ipv4_blocks:
      - from: "172.17.116.32"
        size: 16
      - from: "172.17.116.64"
        size: 16
    ipv6_config:
      prefix: 64
      gateway: "2001:db8::1"
      primary_dns: "2001:4860:4860::8888"
      secondary_dns: "2001:4860:4860::8844"
    ipv6_blocks:
      - from: "2001:db8::2"
        size: 64
      - from: "2001:db8::42"
        size: 64
    tags:
      - Key: Site
        Value: RCDN


- name: Configure IP Pool with block level config
  cisco.intersight.intersight_ip_pool:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-ip-pool
    description: IP Pool for lab use
    enable_block_level_subnet_config: true
    ipv4_blocks:
      - from: "172.17.116.32"
        size: 16
        ipv4_config:
          netmask: "255.255.255.0"
          gateway: "172.17.116.1"
          primary_dns: "172.17.116.2"
          secondary_dns: "172.17.116.3"
      - from: "172.17.117.32"
        size: 16
        ipv4_config:
          netmask: "255.255.255.0"
          gateway: "172.17.117.1"
          primary_dns: "172.17.117.2"
          secondary_dns: "172.17.117.3"
    ipv6_blocks:
      - from: "2001:db8::2"
        size: 64
        ipv6_config:
          prefix: 64
          gateway: "2001:db8::1"
          primary_dns: "2001:4860:4860::8888"
          secondary_dns: "2001:4860:4860::8844"
      - from: "fd12:3456:789a::1"
        size: 64
        ipv6_config:
          prefix: 64
          gateway: "fd12:3456:789a::1"
          primary_dns: "2606:4700:4700::1111"
          secondary_dns: "2606:4700:4700::1001"
    tags:
      - Key: Site
        Value: RCDN


- name: Delete IP Pool
  cisco.intersight.intersight_ip_pool:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-ip-pool
    state: absent

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

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

Ключ

Описание

api_response

dictionary

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

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

Пример: {"api_response": {"AccountMoid": "", "Ancestors": [], "Assigned": 0, "AssignmentOrder": "sequential", "ClassId": "ippool.Pool", "CreateTime": "", "Description": "IP Pool for lab use", "DomainGroupMoid": "", "EnableBlockLevelSubnetConfig": true, "IpV4Blocks": [], "IpV4Config": {}, "IpV6Blocks": [], "IpV6Config": {}, "ModTime": "", "Moid": "", "Name": "lab-ip-pool", "ObjectType": "ippool.Pool", "Organization": {}, "Owners": [], "PermissionResources": [], "Reservations": [], "Reserved": 0, "ShadowPools": [], "SharedScope": "", "Size": 160, "Tags": [{"Key": "Site", "Value": "RCDN"}], "V4Assigned": 0, "V4Size": 32, "V6Assigned": 0, "V6Size": 128}}

Авторы

  • Shahar Golshani (@sgolshan)

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

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

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

Spec-Zone.ru

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