nuage_vspk - Управление средами Nuage VSP
Новая версия с 2.4.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Управление или поиск сущностей Nuage VSP, включая создание, обновление, удаление, привязку, отвязку и поиск со всеми поддерживаемыми свойствами.
Требования (к хосту, на котором выполняется модуль)
- Python 2.7
- Поддержка Nuage VSP 4.0Rx и 5.x.y
- Установленный VSPK-Python для вашей версии Nuage
- Проверено с NuageX https://nuagex.io
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| auth | да | Словарь с информацией об аутентификации, необходимой для подключения к среде Nuage VSP. Требуется параметр api_username (например, csproot). Требуется либо параметр api_password (например, csproot), либо параметры api_certificate и api_key, указывающие на файлы сертификата и ключа для аутентификации на основе сертификата. Требуется параметр api_enterprise (например, csp). Требуется параметр api_url (например, https://10.0.0.10:8443). Требуется параметр api_version (например, v4_0). | ||
| children | нет | Может быть использован для указания набора дочерних сущностей. Обязательное свойство каждого дочернего элемента — type. Поддерживаемые необязательные свойства каждого дочернего элемента — id, properties и match_filter. Функция каждого из этих свойств такая же, как в общем определении задачи. Это может быть использовано рекурсивно Используется только в случае state=present. | ||
| command | нет |
| Указывает команду для выполнения. При command=find, если parent_id и parent_type определены, поиск будет осуществляться только внутри родителя. В противном случае, если разрешено, поиск будет производиться в корневом объекте. При command=find, если id указан, будет возвращена только одна сущность, соответствующая id. При command=find, в противном случае, если определён match_filter, будет использоваться этот фильтр для поиска. При command=find, в противном случае, если определены properties, будет выполнен поиск по всем свойствам с условием AND. При command=change_password, пароль пользователя может быть изменён. Предупреждение — если пароль совпадает с существующим, произойдёт ошибка. При command=wait_for_job, модуль ожидает, пока задача получит статус SUCCESS или ERROR. Если найден статус ERROR, модуль завершится с ошибкой. При command=wait_for_job, задача всегда будет возвращена, даже если состояние — ERROR. Должен быть определён либо state, либо command, оба не могут быть определены одновременно. | |
| id | нет | Идентификатор сущности, с которой требуется взаимодействовать. В сочетании с command=find, возвращается только одна сущность. В сочетании с state, данная сущность будет обновлена или удалена. Будет иметь приоритет над match_filter и properties при необходимости поиска сущности. | ||
| match_filter | нет | Фильтр, используемый при поиске (как в command, так и в state) сущностей в формате, ожидаемом API Nuage VSP. Если match_filter определён, он имеет приоритет над properties, но не над id
| ||
| parent_id | нет | Идентификатор родителя сущности, с которой требуется взаимодействовать. Если state указан, сущность будет взята из этого родителя, если он существует, если не указан id. Если command=find, сущность будет найдена у этого родителя, если не указан id. Если указан, также должен быть указан parent_type. | ||
| parent_type | нет | Тип родителя для указанного id (например, Enterprise). Должен соответствовать имени класса сущности в CamelCase в VSPK-Python. Это имя класса можно найти на https://nuagenetworks.github.io/vspkdoc/html/index.html. Если указан, также должен быть указан parent_id. | ||
| properties | нет | Свойства — пары ключ-значение различных свойств сущности. Если не указан id и match_filter, они используются для поиска или определения существования сущности. | ||
| state | нет |
| Указывает желаемое состояние сущности. Если state=present, если сущность уже существует, она будет обновлена, если это необходимо. Если state=present, если отношение с родителем является отношением членства, сущность будет привязана к родителю. Если state=absent, если отношение с родителем является отношением членства, сущность будет отвязана от родителя. Должен быть определён либо state, либо command, оба не могут быть определены одновременно. | |
| type | да | Тип сущности, с которой требуется взаимодействовать (например, Enterprise). Должен соответствовать имени класса сущности в CamelCase в VSPK-Python. Это имя класса можно найти на https://nuagenetworks.github.io/vspkdoc/html/index.html. |
Примеры
# This can be executed as a single role, with the following vars
# vars:
# auth:
# api_username: csproot
# api_password: csproot
# api_enterprise: csp
# api_url: https://10.0.0.10:8443
# api_version: v5_0
# enterprise_name: Ansible-Enterprise
# enterprise_new_name: Ansible-Updated-Enterprise
#
# or, for certificate based authentication
# vars:
# auth:
# api_username: csproot
# api_certificate: /path/to/user-certificate.pem
# api_key: /path/to/user-Key.pem
# api_enterprise: csp
# api_url: https://10.0.0.10:8443
# api_version: v5_0
# enterprise_name: Ansible-Enterprise
# enterprise_new_name: Ansible-Updated-Enterprise
# Creating a new enterprise
- name: Create Enterprise
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: Enterprise
state: present
properties:
name: "{{ enterprise_name }}-basic"
register: nuage_enterprise
# Checking if an Enterprise with the new name already exists
- name: Check if an Enterprise exists with the new name
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: Enterprise
command: find
properties:
name: "{{ enterprise_new_name }}-basic"
ignore_errors: yes
register: nuage_check_enterprise
# Updating an enterprise's name
- name: Update Enterprise name
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: Enterprise
id: "{{ nuage_enterprise.id }}"
state: present
properties:
name: "{{ enterprise_new_name }}-basic"
when: nuage_check_enterprise | failed
# Creating a User in an Enterprise
- name: Create admin user
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: User
parent_id: "{{ nuage_enterprise.id }}"
parent_type: Enterprise
state: present
match_filter: "userName == 'ansible-admin'"
properties:
email: "ansible@localhost.local"
first_name: "Ansible"
last_name: "Admin"
password: "ansible-password"
user_name: "ansible-admin"
register: nuage_user
# Updating password for User
- name: Update admin password
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: User
id: "{{ nuage_user.id }}"
command: change_password
properties:
password: "ansible-new-password"
ignore_errors: yes
# Finding a group in an enterprise
- name: Find Administrators group in Enterprise
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: Group
parent_id: "{{ nuage_enterprise.id }}"
parent_type: Enterprise
command: find
properties:
name: "Administrators"
register: nuage_group
# Assign the user to the group
- name: Assign admin user to administrators
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: User
id: "{{ nuage_user.id }}"
parent_id: "{{ nuage_group.id }}"
parent_type: Group
state: present
# Creating multiple DomainTemplates
- name: Create multiple DomainTemplates
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: DomainTemplate
parent_id: "{{ nuage_enterprise.id }}"
parent_type: Enterprise
state: present
properties:
name: "{{ item }}"
description: "Created by Ansible"
with_items:
- "Template-1"
- "Template-2"
# Finding all DomainTemplates
- name: Fetching all DomainTemplates
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: DomainTemplate
parent_id: "{{ nuage_enterprise.id }}"
parent_type: Enterprise
command: find
register: nuage_domain_templates
# Deleting all DomainTemplates
- name: Deleting all found DomainTemplates
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: DomainTemplate
state: absent
id: "{{ item.ID }}"
with_items: "{{ nuage_domain_templates.entities }}"
when: nuage_domain_templates.entities is defined
# Unassign user from group
- name: Unassign admin user to administrators
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: User
id: "{{ nuage_user.id }}"
parent_id: "{{ nuage_group.id }}"
parent_type: Group
state: absent
# Deleting an enterprise
- name: Delete Enterprise
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: Enterprise
id: "{{ nuage_enterprise.id }}"
state: absent
# Setup an enterprise with Children
- name: Setup Enterprise and domain structure
connection: local
nuage_vspk:
auth: "{{ nuage_auth }}"
type: Enterprise
state: present
properties:
name: "Child-based-Enterprise"
children:
- type: L2DomainTemplate
properties:
name: "Unmanaged-Template"
children:
- type: EgressACLTemplate
match_filter: "name == 'Allow All'"
properties:
name: "Allow All"
active: true
default_allow_ip: true
default_allow_non_ip: true
default_install_acl_implicit_rules: true
description: "Created by Ansible"
priority_type: "TOP"
- type: IngressACLTemplate
match_filter: "name == 'Allow All'"
properties:
name: "Allow All"
active: true
default_allow_ip: true
default_allow_non_ip: true
description: "Created by Ansible"
priority_type: "TOP"
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| entities | Список обработанных сущностей. Каждый элемент — результат to_dict() сущности. | При state=present и find, с одним элементом в случае state=present или find=one. | список | [{'status': 'RUNNING', 'assocEntityType': 'DOMAIN', 'parameters': None, 'command': 'BEGIN_POLICY_CHANGES', 'entityScope': 'ENTERPRISE', 'parentType': 'domain', 'lastUpdatedBy': '8a6f0e20-a4db-4878-ad84-9cc61756cd5e', 'externalID': None, 'result': None, 'lastUpdatedDate': 1487515656000, 'parentID': 'a22fddb9-3da4-4945-bd2e-9d27fe3d62e0', 'owner': '8a6f0e20-a4db-4878-ad84-9cc61756cd5e', 'progress': 0.0, 'creationDate': 1487515656000, 'ID': 'acabc435-3946-4117-a719-b8895a335830"'}] |
| id | Идентификатор сущности, которая была найдена, создана, обновлена или привязана. | При state=present и command=find в случае одной найденной сущности. | строка | bae07d8d-d29c-4e2b-b6ba-621b4807a333 |
Примечания
Примечание
- Режим проверки поддерживается, но с некоторыми оговорками. Он не будет вносить изменений и, по возможности, попытается определить, может ли выполнить запрос.
- Если идентификатор родителя получен из предыдущей задачи, он может быть пустым, и если поиск возможен в корневом элементе, он будет выполнен, что может повлиять на производительность.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, прочитайте Информацию о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nuage_vspk_module.html