Spec-Zone.ru › Ansible

Модуль hitachivantara.vspone_object.oneobject_node.hv_storage_component — создание или обновление компонента хранилища

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_object (версия 1.1.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install hitachivantara.vspone_object. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_object.oneobject_node.hv_storage_component.

Добавлено в hitachivantara.vspone_object 1.0.0

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

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

  • Этот модуль создаёт или обновляет компонент хранилища в Hitachi VSP One Object.

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

  • python >= 3.7

Параметры

Параметр

Комментарии

connection_info

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

Информация, необходимая для установки подключения к системе.

cluster_name

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

Имя кластера системы.

http_request_retry_interval_seconds

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

Интервал между повторными попытками выполнения HTTP-запроса.

http_request_retry_times

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

Количество повторных попыток выполнения HTTP-запроса.

http_request_timeout

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

Время ожидания HTTP-запросов.

oneobject_node_client_id

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

Идентификатор для аутентификации.

oneobject_node_client_secret

string

Секрет для аутентификации.

oneobject_node_username

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

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

oneobject_node_userpass

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

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

region

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

Регион системы.

ssl

dictionary

Конфигурация SSL.

ca_certs

string

Путь к файлу сертификатов центра сертификации (CA).

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

ca_path

string

Путь к файлу сертификата центра сертификации (CA).

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

check_hostname

boolean

Проверять ли имя хоста.

Варианты:

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

client_cert

string

Путь к файлу сертификата клиента.

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

client_key

string

Путь к файлу ключа клиента.

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

ssl_cipher

string

Используемый шифр SSL.

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

ssl_version

string

Используемая версия SSL.

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

validate_certs

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

Проверять ли сертификаты SSL.

Варианты:

  • false
  • true

spec

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

Спецификация модуля компонента хранилища

id

string

Идентификатор компонента хранилища.

Если указан, выполняется только обновление.

storage_component_config

dictionary

Значения конфигурации компонента хранилища.

access_key

string

Ключ доступа из учетных данных S3 для доступа к бакету.

Обязательно при создании компонента хранилища.

activate_now

boolean

Немедленно активировать компонент хранилища.

Варианты:

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

array_name

string

Имя массива хранения.

array_storage_tier

string

Уровень хранения в массиве хранения.

auth_type

string

Версия подписи AWS, используемая для аутентификации всех взаимодействий с Amazon S3.

Используйте V2 для незащищенного подключения или V4 для защищенного подключения.

Варианты:

  • "V2" ← (по умолчанию)
  • "V4"

bucket

string

Имя бакета.

Бакет должен быть создан заранее.

Обязательно при создании компонента хранилища.

connection_timeout

integer

Время ожидания установки HTTP-соединения (в миллисекундах).

connection_ttl

integer

Время жизни соединения (TTL) для запроса.

data_claim_capacity

string

Объем хранилища, запрашиваемый для компонента хранилища.

data_persistent_volume_name

string

Постоянный том (PV), связанный с компонентом хранилища.

host

string

URL домена хоста серверной части компонента хранилища.

Обязательно при создании компонента хранилища.

label

string

Имя компонента хранилища.

Обязательно при создании компонента хранилища.

management_host

string

Требуется для компонента хранилища узла VSP One Object S Series.

Укажите IP-адрес системы управления или полное доменное имя.

Не указывайте для других типов компонентов хранилища.

management_password

string

Требуется для компонента хранилища узла VSP One Object S Series.

Учетные данные — пароль.

Не указывайте для других типов компонентов хранилища.

management_protocol

string

Требуется для компонента хранилища узла VSP One Object S Series.

Протокол обмена данными для запросов MAPI.

Не указывайте для других типов компонентов хранилища.

management_user

string

Требуется для компонента хранилища узла VSP One Object S Series.

Учетные данные — имя пользователя с правами администратора.

Не указывайте для других типов компонентов хранилища.

max_connections

integer

Максимальное количество открытых HTTP-соединений с компонентом хранилища.

namespace

string

Пространство имен Kubernetes, связанное с компонентом хранилища.

node

string

Узел кластера Kubernetes, на котором необходимо выделить хранилище.

port

string

HTTP-порт серверной системы.

Обязательно при создании компонента хранилища.

proxy_domain

string

Домен прокси-сервера. Не поддерживается.

proxy_host

string

Хост прокси-сервера.

proxy_password

string

Пароль домена прокси-сервера.

proxy_port

string

Номер порта прокси-сервера.

proxy_user_name

string

Имя пользователя домена прокси-сервера.

region

string

Регион S3. Обязательно при создании компонента хранилища.

secret_key

string

Секретный ключ из учетных данных S3 для доступа к бакету.

Обязательно при создании компонента хранилища.

socket_recv_buffer_size_hint

integer

Рекомендуемый размер буфера приема низкоуровневого TCP-соединения в байтах.

Если этот параметр указан, необходимо также указать socketSendBufferSizeHint.

socket_send_buffer_size_hint

integer

Рекомендуемый размер буфера отправки низкоуровневого TCP-соединения в байтах.

Если этот параметр указан, необходимо также указать socketRecvBufferSizeHint.

socket_timeout

integer

Время ожидания при чтении из подключенного сокета.

storage_class

string

Класс хранилища, связанный с компонентом хранилища.

Обязательно при создании компонента хранилища.

storage_fault_domain

string

Домен отказа, связанный с компонентом хранилища.

Обязательно при создании компонента хранилища.

uri_scheme

string

Схема унифицированного идентификатора ресурса (URI), используемая при доступе к ресурсу.

Используйте HTTP для незащищенного подключения или HTTPS для защищенного подключения.

Варианты:

  • "HTTP"
  • "HTTPS"

use_path_style_always

boolean

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

Если значение равно false, используется стиль виртуального хоста.

Если значение не указано, по умолчанию используется true.

Варианты:

  • false
  • true

use_proxy

boolean

Если значение равно true, необходимо указать значения для proxy_host, proxy_port, proxy_user_name и proxy_password.

Варианты:

  • false
  • true

user_agent_prefix

string

Префикс заголовка HTTP User-Agent, используемый в запросах к компоненту хранилища.

storage_custom_metadata

dictionary

Метаданные, назначенные компоненту хранилища.

storage_type

string

Тип компонента хранилища.

Задайте для storage_type значение HCPS_S3 для компонента хранилища HCPS S3.

Задайте для storage_type значение ARRAY для блочного компонента хранилища VSP SDS.

Варианты:

  • "HCPS_S3"
  • "ARRAY"

state

string

Задайте для операции значение activate, чтобы активировать компонент хранилища

Задайте для операции значение test, чтобы проверить подключение компонента хранилища

Задайте для операции значение present, чтобы создать или обновить компонент хранилища

Варианты:

  • "activate"
  • "test"
  • "present"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: отсутствует

Определяет, должен ли модуль выполняться в режиме проверки.

Примеры

- name: Activate storage component in Hitachi VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_storage_component:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    state: "activate"
    spec:
      id: 759156789

- name: Create storage component in Hitachi VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_storage_component:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
      state: "present"
      spec:
        storage_type: "HCPS_S3"
        storage_component_config:
          label: "component-test6"
          host: "172.25.57.10"
          storage_class: "A1-CLASS-3_123"
          storage_fault_domain: "humphrey-storage-test"
          uri_scheme: "HTTP"
          port: "80"
          bucket: "ansiblecreate6"
          region: "us-west-2b"
          auth_type: "V2"
          access_key: "dxfchgvjh"
          secret_key: "thsfgndzbfvzdc"
          use_proxy: false
          proxy_host: ~
          proxy_port: ~
          proxy_user_name: ~
          proxy_password: ~
          management_user: "johndoenag"
          management_password: "Passw0rd!"
          management_protocol: "HTTPS"
          management_host: "172.25.57.10:9090/mapi"
          use_path_style_always: false
          activate_now: false

- name: Update storage component in Hitachi VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_storage_component:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
      state: "present"
      spec:
        storage_type: "HCPS_S3"
        storage_component_config:
          label: "component-test6"
          host: "172.25.57.10"
          storage_class: "A1-CLASS-3_123"
          storage_fault_domain: "humphrey-storage-test"
          uri_scheme: "HTTP"
          port: "80"
          bucket: "ansiblecreate6"
          region: "us-west-2b"
          auth_type: "V2"
          access_key: "dxfchgvjh"
          secret_key: "thsfgndzbfvzdc"
          use_proxy: false
          proxy_host: ~
          proxy_port: ~
          proxy_user_name: ~
          proxy_password: ~
          management_user: "johndoenag"
          management_password: "Passw0rd!"
          management_protocol: "HTTPS"
          management_host: "172.25.57.10:9090/mapi"
          use_path_style_always: false
          activate_now: false

- name: Test storage component access in Hitachi VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_storage_component:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    state: "test"
    spec:
      id: 759156789

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

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

Ключ

Описание

storage_component

dictionary

Компонент хранилища и его атрибуты.

Возвращается: при успешном выполнении

id

integer

Идентификатор компонента хранилища.

Возвращается: при успешном выполнении

Пример: 1473644437

storage_class_id

integer

Идентификатор класса хранилища Kubernetes, назначенного компоненту хранилища.

Возвращается: при успешном выполнении

Пример: -1128696871

storage_component_config

dictionary

Значения конфигурации компонента хранилища.

Возвращается: при успешном выполнении

array_lun

string

LUN в массиве хранения.

Возвращается: при успешном выполнении

Пример: "lun1"

array_name

string

Имя массива хранения.

Возвращается: при успешном выполнении

Пример: "vsp_array_01"

array_namespace

string

Пространство имён в массиве хранения.

Возвращается: при успешном выполнении

Пример: "namespace1"

array_storage_tier

string

Уровень хранения в массиве хранения.

Возвращается: при успешном выполнении

Пример: "nvme-tlc"

auth_type

string

Версия подписи AWS для аутентификации всех взаимодействий с Amazon S3.

Возвращается: при успешном выполнении

Пример: "V2"

bucket

string

Имя бакета.

Возвращается: при успешном выполнении

Пример: "test_bucket"

connection_ttl

integer

Время жизни подключения (TTL) для запроса.

Возвращается: при успешном выполнении

Пример: 0

host

string

URL домена узла серверной части компонента хранилища.

Возвращается: при успешном выполнении

Пример: "urloripaddressofcomponent"

label

string

Имя компонента хранилища.

Возвращается: при успешном выполнении

Пример: "component-test6"

management_host

string

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

Возвращается: при успешном выполнении

Пример: "urloripaddressofcomponentmapi"

management_protocol

string

Протокол связи для запросов MAPI.

Возвращается: при успешном выполнении

Пример: "HTTPS"

max_connections

integer

Максимальное количество подключений для компонента хранилища.

Возвращается: при успешном выполнении

Пример: 1024

port

integer

Порт HTTP серверной системы.

Возвращается: при успешном выполнении

Пример: 80

region

string

Регион S3.

Возвращается: при успешном выполнении

Пример: "us-west-2b"

site_affiliation

dictionary

Сведения о привязке компонента хранилища к сайту.

Возвращается: при успешном выполнении

id

string

Уникальный идентификатор привязки к сайту.

Возвращается: при успешном выполнении

Пример: "6e8ba3a8-b477-484a-95cf-9d3b29e1699d"

socket_timeout

integer

Значение времени ожидания при чтении из подключённого сокета.

Возвращается: при успешном выполнении

Пример: 31000

state

string

Текущее состояние компонента хранилища.

Возвращается: при успешном выполнении

Пример: "UNVERIFIED"

uri_scheme

string

Схема универсального идентификатора ресурса (URI), используемая при доступе к ресурсу.

Возвращается: при успешном выполнении

Пример: "HTTP"

use_path_style_always

boolean

Использовать ли для компонента хранилища адресацию в стиле пути.

Возвращается: при успешном выполнении

Пример: false

use_proxy

boolean

Использовать ли прокси для компонента хранилища.

Возвращается: при успешном выполнении

Пример: false

storage_custom_metadata

dictionary

Пользовательские метаданные компонента хранилища.

Возвращается: при успешном выполнении

Пример: {}

storage_fault_domain_id

string

Уникальный идентификатор домена отказа хранилища.

Возвращается: при успешном выполнении

Пример: "073cddb1-01f2-45a3-8688-50a1483d9e53"

storage_type

string

Тип компонента хранилища.

Возвращается: при успешном выполнении

Пример: "HCPS_S3"

Авторы

  • Hitachi Vantara, LTD. (@hitachi-vantara)

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

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

© 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/hitachivantara/vspone_object/oneobject_node.hv_storage_component_module.html

Spec-Zone.ru

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