Модуль vmware.vmware_rest.content_subscribedlibrary — создает новую библиотеку с подпиской

client_token

string

Уникальный токен, создаваемый клиентом для каждого запроса на создание. Токен должен быть универсальным уникальным идентификатором (UUID), например: b8a2a2e3-2314-43cd-a871-6ede0f429751. Этот токен можно использовать для обеспечения идемпотентного создания.

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

creation_time

string

Дата и время создания этой библиотеки.

Это поле не используется при выполнении операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Оно не используется при выполнении операции обновления.

description

string

Понятное человеку описание этой библиотеки.

Это поле необязательно для операции создания. Если не задавать его при создании, его значение будет пустой строкой. Оно всегда присутствует в результатах операции получения или перечисления. Для операции обновления поле необязательно. Если не задавать его при обновлении, описание останется без изменений.

id

string

Идентификатор, однозначно определяющий этот LibraryModel.

Это поле не используется при выполнении операции создания. Оно не будет присутствовать в результатах операций получения или перечисления. Оно не используется при выполнении операции обновления.

Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.content_library_info.

last_modified_time

string

Дата и время последнего обновления этой библиотеки.

Это поле обновляется автоматически при изменении свойств библиотеки. На него не влияет добавление, удаление или изменение элемента библиотеки либо его содержимого. Добавление тегов к библиотеке или синхронизация подписанной библиотеки не изменяют это поле.

Это поле не используется при выполнении операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Оно не используется при выполнении операции обновления.

last_sync_time

string

Дата и время последней синхронизации этой библиотеки.

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

Это поле не используется при выполнении операции создания. В результатах операций получения или перечисления оно является необязательным. Оно не используется при выполнении операции обновления.

library_id

string

Идентификатор подписанной библиотеки, содержимое которой следует удалить из кэша.

Параметр должен содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.content_library_info. Обязателен при state=[‘absent’, ‘evict’, ‘present’, ‘sync’]

name

string

Имя библиотеки.

Библиотека определяется по понятному человеку имени. Имя библиотеки не может быть неопределенным или пустым. Имена не должны быть уникальными.

Это поле необходимо указать для операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Для операции обновления оно необязательно.

optimization_info

dictionary

Определяет различные оптимизации и параметры оптимизации, применяемые к этой библиотеке.

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

Допустимые атрибуты:

- optimize_remote_publishing (bool): Если задано значение true, библиотека будет оптимизирована для удаленной публикации.

Включите этот параметр, если удаленная публикация является основным сценарием использования этой библиотеки. Под удаленной публикацией здесь подразумевается, что издатель и подписчики не входят в один домен Vcenter SSO.

В результате включения этой оптимизации при создании библиотеки могут быть выполнены различные оптимизации. Например, содержимое библиотеки может храниться в другом формате, однако оптимизации не ограничиваются только форматом хранения.

Обратите внимание, что значение этого параметра можно задать только при создании библиотеки. Если потребуется изменить это значение (оптимизировать библиотеку для другого сценария использования), библиотеку необходимо будет перенести.

Это поле необязательно для операции создания. Если при создании оно не указано, библиотека по умолчанию не оптимизируется для определенного сценария использования. Оно не используется при выполнении операции обновления. ([‘present’])

publish_info

dictionary

Определяет способ публикации этой библиотеки, чтобы на нее могла подписаться удаленная подписанная библиотека.

PublishInfo определяет, где и каким образом доступны метаданные этой локальной библиотеки. Локальная библиотека публикуется для общего доступа только в том случае, если PublishInfo.published имеет значение true.

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

Допустимые атрибуты:

- authentication_method (str): Этот параметр указывает, как подписанная библиотека должна проходить аутентификацию в конечной точке опубликованной библиотеки. ([‘present’])

- Допустимые значения:

- BASIC

- NONE

- published (bool): Указывает, опубликована ли локальная библиотека.

Это поле необходимо для операции LocalLibrary.create. Для операции LocalLibrary.update оно необязательно; если значение не задано, оно не изменится. Если для существующего метода аутентификации задано значение BASIC и локальная библиотека опубликована, перед отключением публикации необходимо указать поле PublishInfo.current-password. Это поле всегда присутствует в результатах операции LocalLibrary.get. ([‘present’])

- publish_url (str): URL-адрес, по которому служба Content Library публикует метаданные библиотеки.

Это значение можно использовать для задания свойства SubscriptionInfo.subscription-url при создании подписанной библиотеки.

Это поле не используется при выполнении операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Оно не используется при выполнении операции обновления. ([‘present’])

- user_name (str): Имя пользователя, необходимое для аутентификации.

Это поле необязательно для операций LocalLibrary.create и LocalLibrary.update. Если выбран метод аутентификации NONE, имя пользователя можно не задавать. Если выбран метод аутентификации BASIC, в текущем выпуске имя пользователя игнорируется. По умолчанию используется значение “vcsp”. Предпочтительно не задавать это поле. Если оно указано, его значение должно быть “vcsp”. ([‘present’])

- password (str): Новый пароль, необходимый для аутентификации.

Это поле необязательно для операции LocalLibrary.create. Если выбран метод аутентификации NONE, пароль можно не задавать. Если выбран метод аутентификации BASIC, пароль должен быть непустой строкой. Для операции LocalLibrary.update это поле необязательно. Если не задавать его при обновлении, пароль останется без изменений. При изменении пароля необходимо указать поле PublishInfo.current-password. Это поле не используется при выполнении операции LocalLibrary.get. ([‘present’])

- current_password (str): Текущий пароль для проверки. Это поле доступно начиная с vSphere 6.7.

Это поле не используется при выполнении операции LocalLibrary.create. Для операции LocalLibrary.update оно необязательно. Если для существующего метода аутентификации задано значение NONE, текущий пароль можно не указывать. Если для существующего метода аутентификации задано значение BASIC, перед применением нового значения PublishInfo.password, отключением аутентификации или отменой публикации библиотеки выполняется проверка текущего пароля. Это поле не используется при выполнении операции LocalLibrary.get. ([‘present’])

- persist_json_enabled (bool): Указывает, сохраняются ли метаданные библиотеки и ее элементов в хранилище в виде файлов JSON. Этот флаг применяется только в том случае, если локальная библиотека опубликована.

Включение сохранения в формате JSON позволяет синхронизировать подписанную библиотеку вручную, а не по протоколу HTTP. Скопируйте содержимое и метаданные локальной библиотеки в другое хранилище вручную, а затем создайте подписанную библиотеку, указав в SubscriptionInfo.subscription-url расположение файла JSON библиотеки. Если хранилище подписанной библиотеки совпадает с URL-адресом подписки, копировать файлы в подписанную библиотеку не требуется.

Для библиотеки, размещенной в хранилище данных, файл JSON библиотеки будет сохранен по пути contentlib-{library_id}/lib.json в хранилище данных.

Для библиотеки, размещенной в удаленной файловой системе, файл JSON библиотеки будет сохранен по пути {library_id}/lib.json в удаленной файловой системе.

Это поле необязательно для операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Для операции обновления оно необязательно. ([‘present’])

security_policy_id

string

Представляет политику безопасности, применяемую к этой библиотеке.

Задание этого поля обеспечивает защиту библиотеки. Это поле игнорируется при выполнении операции обновления, если для LibraryModel.unset-security-policy-id задано значение true.

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

Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.content_library_info.

server_guid

string

Уникальный идентификатор сервера vCenter, на котором находится библиотека.

Это поле необязательно для операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Оно не используется при выполнении операции обновления.

Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_cluster_info.

session_timeout

float

добавлено в vmware.vmware_rest 2.1.0

Параметры времени ожидания для сеанса клиента.

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

Значение по умолчанию — 300 с.

state

string

Варианты:

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

storage_backings

list / elements=dictionary

Список хранилищ по умолчанию, доступных для этой библиотеки.

StorageBacking определяет расположение хранилища по умолчанию, которое можно использовать для файлов элементов этой библиотеки. Некоторые элементы библиотеки, например шаблоны виртуальных машин, поддерживают файлы, распределенные по различным хранилищам. Один или несколько файлов элемента могут находиться или не находиться в хранилище по умолчанию.

В настоящее время поддержка нескольких расположений хранилища по умолчанию отсутствует, но может появиться в будущих выпусках.

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

Допустимые атрибуты:

- type (str): Этот параметр задает тип StorageBacking. ([‘present’])

- Допустимые значения:

- DATASTORE

- OTHER

- datastore_id (str): Идентификатор хранилища данных, используемого для хранения содержимого библиотеки.

Это поле необязательно и имеет значение только в том случае, если значение StorageBacking.type равно DATASTORE.

Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.vcenter_datastore_info. ([‘present’])

- storage_uri (str): URI, указывающий расположение для хранения содержимого библиотеки.

Поддерживаются следующие форматы URI:

vSphere 6.5

- nfs://server/path?version=4 (только для vCenter Server Appliance) — указывает сервер NFS версии 4.

- nfs://server/path (только для vCenter Server Appliance) — указывает сервер NFS версии 3. Также поддерживается формат nfs://server:/path.

- smb://server/path — указывает сервер SMB или общий ресурс Windows.

vSphere 6.0 Update 1

- nfs://server:/path (только для vCenter Server Appliance)

- file://unc-server/path (только для vCenter Server для Windows)

- file:///mount/point (только для vCenter Server Appliance) — локальные URI файлов поддерживаются только в том случае, если путь является локальной точкой подключения файловой системы NFS. Использовать URI файлов настоятельно не рекомендуется. Вместо этого укажите удаленную файловую систему с помощью URI NFS.

vSphere 6.0

- nfs://server:/path (только для vCenter Server Appliance)

- file://unc-server/path (только для vCenter Server для Windows)

- file:///path — локальные URI файлов поддерживаются, но их использование настоятельно не рекомендуется, поскольку они могут отрицательно повлиять на производительность vCenter Server.

Это поле необязательно и имеет значение только в том случае, если значение StorageBacking.type равно OTHER. ([‘present’])

subscription_info

dictionary

Определяет поведение подписки для этой библиотеки.

SubscriptionInfo определяет, как эта подписанная библиотека синхронизируется с удаленным источником. Заданное значение определяет удаленный источник, с которым синхронизируется библиотека, и способ синхронизации. Изменение подписки приведет к синхронизации с новым источником. Если новый источник отличается от прежнего, старые элементы библиотеки и данные будут потеряны. Если задать для SubscriptionInfo.automatic-sync-enabled значение false, подписка будет приостановлена, но существующие кэшированные данные не будут удалены.

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

Допустимые атрибуты:

- authentication_method (str): Указывает, как подписанная библиотека должна проходить аутентификацию в конечной точке опубликованной библиотеки. ([‘present’, ‘probe’])

- Допустимые значения:

- BASIC

- NONE

- automatic_sync_enabled (bool): Указывает, должна ли библиотека участвовать в автоматической синхронизации библиотек. Для выполнения автоматической синхронизации также необходимо задать для глобального параметра ConfigurationModel.automatic-sync-enabled значение true. Подписка остается активной, даже если автоматическая синхронизация отключена, однако синхронизация запускается только при явном вызове SubscribedLibrary.sync или SubscribedItem.sync. Иными словами, ручная синхронизация доступна и при отключенной автоматической синхронизации.

Это поле необходимо указать для операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Для операции обновления оно необязательно. ([‘present’, ‘probe’])

- on_demand (bool): Указывает, будет ли содержимое элемента библиотеки синхронизироваться только по запросу.

Если задано значение true, метаданные элемента библиотеки будут синхронизированы, но его содержимое (файлы) синхронизироваться не будет. Служба Content Library будет синхронизировать содержимое только по запросу. Из-за этого при первом использовании содержимого может возникнуть заметная задержка.

Элементы без синхронизированного содержимого можно принудительно синхронизировать заранее, вызвав SubscribedItem.sync со значением true для forceSyncContent. После синхронизации содержимое можно удалить с помощью вызова SubscribedItem.evict.

Если задано значение false, все содержимое будет синхронизировано заранее.

Это поле необходимо указать для операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Для операции обновления оно необязательно. ([‘present’, ‘probe’])

- password (str): Пароль, используемый для аутентификации.

При использовании метода аутентификации на основе пароля пароль необходимо задать; пустые строки не допускаются.

Это поле необязательно для операции создания. Оно не будет присутствовать в результатах операций получения или перечисления. Для операции обновления оно необязательно. ([‘present’, ‘probe’])

- ssl_thumbprint (str): Необязательный хеш SSL-сертификата удаленной конечной точки SHA-1.

Если это значение задано, SSL-сертификат будет проверен путем сравнения с отпечатком SSL. SSL-сертификат должен соответствовать отпечатку. Если значение указано, стандартная проверка цепочки сертификатов не выполняется. Если значение не задано, цепочка сертификатов проверяется обычным образом. Указанное значение sslThumbprint не будет проверяться при проверке SSL-сертификата, если также задано значение {SubscriptionInfo#sslCertificate}.

Это поле необязательно для операции создания. Оно не будет присутствовать в результатах операций получения или перечисления. Для операции обновления оно необязательно. ([‘present’, ‘probe’])

- subscription_url (str): URL-адрес конечной точки, с которой предоставляются метаданные удаленно опубликованной библиотеки.

Это может быть значение PublishInfo.publish-url опубликованной библиотеки (например, https://server/path/lib.json).

Если исходное содержимое поступает из опубликованной библиотеки со значением true для PublishInfo.persist-json-enabled, URL-адрес подписки может указывать на файл JSON библиотеки в хранилище данных или удаленной файловой системе. Поддерживаются следующие форматы:

vSphere 6.5

- ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (для хранилища данных)

- nfs://server/path/mylibrary/lib.json (для сервера NFSv3 на vCenter Server Appliance)

- nfs://server/path/mylibrary/lib.json?version=4 (для сервера NFSv4 на vCenter Server Appliance)

- smb://server/path/mylibrary/lib.json (для сервера SMB)

vSphere 6.0

- file://server/mylibrary/lib.json (для сервера UNC на vCenter Server для Windows)

- file:///path/mylibrary/lib.json (для локальной файловой системы)

Если указать URL-адрес подписки DS, хранилище данных должно находиться на том же сервере vCenter, что и подписанная библиотека. Если указать URL-адрес подписки NFS или SMB, значение StorageBacking.storage-uri подписанной библиотеки должно указывать на тот же удаленный файловый сервер и иметь общий родительский путь с URL-адресом подписки.

Это поле необходимо указать для операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Для операции обновления оно необязательно. ([‘present’, ‘probe’])

- user_name (str): Имя пользователя, используемое для аутентификации.

При использовании метода аутентификации на основе пароля имя пользователя необходимо задать. Пустые строки в качестве имени пользователя допускаются.

Это поле необязательно для операции создания. В результатах операций получения или перечисления оно является необязательным. Для операции обновления оно необязательно. ([‘present’, ‘probe’])

- source_info (dict): Информация об исходной опубликованной библиотеке. Это поле задается для подписанной библиотеки, связанной с подпиской на опубликованную библиотеку.

Это поле необязательно для операции создания. В результатах операций получения или перечисления оно является необязательным. Для операции обновления оно необязательно. ([‘present’, ‘probe’])

- Допустимые ключи:

- source_library (string): Идентификатор опубликованной библиотеки.

Это поле необходимо указать для операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Для операции обновления оно необязательно.

Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.content_library_info.

- subscription (string): Идентификатор подписки, связанной с подписанной библиотекой.

Это поле необходимо указать для операции создания. Оно всегда присутствует в результатах операций получения или перечисления. Для операции обновления оно необязательно.

Если клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурса, возвращенного методом vmware.vmware_rest.content_library_subscriptions_info.

type

string

Перечисляемый тип library_type определяет тип LibraryModel.

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

Варианты:

• "LOCAL"
• "SUBSCRIBED"

unset_security_policy_id

boolean

Это поле указывает на предполагаемое изменение LibraryModel.security-policy-id при выполнении операции обновления.

Если для этого поля задано значение true, все примененные к библиотеке политики безопасности будут удалены. Если для этого поля задано значение false, все примененные к библиотеке политики безопасности будут заменены значением LibraryModel.security-policy-id, если оно задано.

Это поле необязательно для операции обновления. Если оно не задано, все существующие политики безопасности будут заменены значением LibraryModel.security-policy-id, если оно задано.

Варианты:

• false
• true

vcenter_hostname

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

Имя хоста или IP-адрес vSphere vCenter

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

vcenter_password

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

Пароль vSphere vCenter

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

vcenter_rest_log_file

string

Этот необязательный параметр позволяет указать расположение файла журнала.

Этот файл будет использоваться для записи взаимодействия по протоколу HTTP REST.

Файл будет сохранён на узле, на котором выполняется модуль.

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

переменной среды VMWARE_REST_LOG_FILE.

vcenter_username

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

Имя пользователя vSphere vCenter

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_USER.

vcenter_validate_certs

boolean

Разрешает подключение, если SSL-сертификаты недействительны. Установите значение false, если сертификаты не являются доверенными.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.

Варианты:

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

version

string

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

Это значение представляет собой число, которое увеличивается при каждом изменении свойств библиотеки, например её имени или описания. Оно не увеличивается при изменении элементов библиотеки, включая добавление и удаление элементов. Добавление тегов к библиотеке также не влияет на это значение.

Это поле не используется при создании. Оно всегда присутствует в результате операции получения или перечисления. При обновлении оно является необязательным. Если не указывать его при обновлении, это означает, что обнаруживать параллельные обновления не требуется.

msg

string

Удаление всех подписанных библиотек

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

Пример: "All items completed"

results

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

Удаление всех подписанных библиотек

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

Пример: [{"_ansible_item_label": {"creation_time": "2022-11-23T20:06:05.189Z", "description": "", "id": "8b4e355e-a463-44f1-9b04-d0786a49cc7d", "last_modified_time": "2022-11-23T20:06:05.189Z", "last_sync_time": "2022-11-23T20:06:07.717Z", "name": "sub_lib", "server_guid": "52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5", "storage_backings": [{"datastore_id": "datastore-1065", "type": "DATASTORE"}], "subscription_info": {"authentication_method": "NONE", "automatic_sync_enabled": 0, "on_demand": 1, "subscription_url": "https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json"}, "type": "SUBSCRIBED", "version": "4"}, "_ansible_no_log": null, "ansible_loop_var": "item", "changed": 1, "failed": 0, "invocation": {"module_args": {"client_token": null, "creation_time": null, "description": null, "id": null, "last_modified_time": null, "last_sync_time": null, "library_id": "8b4e355e-a463-44f1-9b04-d0786a49cc7d", "name": null, "optimization_info": null, "publish_info": null, "server_guid": null, "session_timeout": null, "state": "absent", "storage_backings": null, "subscription_info": null, "type": null, "vcenter_hostname": "vcenter.test", "vcenter_password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "vcenter_rest_log_file": "/tmp/vmware_rest.log", "vcenter_username": "administrator@vsphere.local", "vcenter_validate_certs": 0, "version": null}}, "item": {"creation_time": "2022-11-23T20:06:05.189Z", "description": "", "id": "8b4e355e-a463-44f1-9b04-d0786a49cc7d", "last_modified_time": "2022-11-23T20:06:05.189Z", "last_sync_time": "2022-11-23T20:06:07.717Z", "name": "sub_lib", "server_guid": "52fb0b5e-ffc3-465b-bf4f-e4e6d5423cf5", "storage_backings": [{"datastore_id": "datastore-1065", "type": "DATASTORE"}], "subscription_info": {"authentication_method": "NONE", "automatic_sync_enabled": 0, "on_demand": 1, "subscription_url": "https://vcenter.test:443/cls/vcsp/lib/a66d5c73-57f8-4a3a-9361-292a55f68516/lib.json"}, "type": "SUBSCRIBED", "version": "4"}, "value": {}}]