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 указано, возвращается только соответствующая сущность. При command=find, в противном случае, если определён match_filter, используется этот фильтр для поиска. При command=find, в противном случае, если определены properties, выполняется поиск по всем свойствам с логикой «И». При command=change_password, пароль пользователя может быть изменён. Предупреждение - Если пароль совпадает с существующим, будет выдано сообщение об ошибке. При command=wait_for_job, модуль будет ожидать, пока задача получит статус SUCCESS или ERROR. В случае обнаружения статуса ERROR, модуль завершится с ошибкой. При command=wait_for_job, задача всегда будет возвращена, даже если состояние является ошибкой. Необходимо определить либо 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_id, также должен быть указан parent_type. | |
| parent_type - | Тип родителя, для которого указан идентификатор (например, Корпоративное предприятие). Должен соответствовать имени класса CamelCase в VSPK-Python. Это имя класса можно найти на https://nuagenetworks.github.io/vspkdoc/index.html. Если указан parent_type, также должен быть указан parent_id. | |
| properties - | Свойства — это пары ключ-значение различных свойств сущности. Если не указаны id и match_filter, эти свойства используются для поиска или определения существования сущности. | |
| state - |
| Определяет желаемое состояние сущности. Если state=present, в случае, если сущность уже существует, она будет обновлена, если это необходимо. Если state=present и отношение с родителем является отношением членства, сущность будет назначена как член родителя. Если state=absent и отношение с родителем является отношением членства, сущность будет исключена из членства в родителе. Необходимо определить либо state, либо command; одновременное определение обоих невозможно. |
| type - / обязательно | Тип сущности, над которой вы хотите работать (например, Корпоративное предприятие). Должен соответствовать имени класса CamelCase в VSPK-Python. Это имя класса можно найти на https://nuagenetworks.github.io/vspkdoc/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 is 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 список | При state=present и find, с одним элементом в случае state=present или find=one. | Список обработанных сущностей. Каждый элемент — это to_dict() сущности. Пример: [{'ID': 'acabc435-3946-4117-a719-b8895a335830"', 'assocEntityType': 'DOMAIN', 'command': 'BEGIN_POLICY_CHANGES', 'creationDate': 1487515656000, 'entityScope': 'ENTERPRISE', 'externalID': None, 'lastUpdatedBy': '8a6f0e20-a4db-4878-ad84-9cc61756cd5e', 'lastUpdatedDate': 1487515656000, 'owner': '8a6f0e20-a4db-4878-ad84-9cc61756cd5e', 'parameters': None, 'parentID': 'a22fddb9-3da4-4945-bd2e-9d27fe3d62e0', 'parentType': 'domain', 'progress': 0.0, 'result': None, 'status': 'RUNNING'}] |
| id строка | При state=present и command=find, в случае, если найдена одна сущность. | Идентификатор сущности, которая была найдена, создана, обновлена или назначена. Пример: bae07d8d-d29c-4e2b-b6ba-621b4807a333 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Philippe Dellaert (@pdellaert)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/nuage_vspk_module.html