File: //usr/lib/python3.9/site-packages/ansible_collections/cisco/ise/plugins/modules/trustsec_vn.py
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: trustsec_vn
short_description: Resource module for Trustsec VN
description:
- Manage operations create, update and delete of the resource Trustsec VN.
- Create Virtual Network.
- Update Virtual Network.
version_added: '2.0.0'
extends_documentation_fragment:
- cisco.ise.module
author: Rafael Campos (@racampos)
options:
additionalAttributes:
description: JSON String of additional attributes for the Virtual Network.
type: str
id:
description: Identifier of the Virtual Network.
type: str
lastUpdate:
description: Timestamp for the last update of the Virtual Network.
type: str
name:
description: Name of the Virtual Network.
type: str
requirements:
- ciscoisesdk >= 2.0.8
- python >= 3.5
seealso:
- name: Cisco ISE documentation for virtualNetwork
description: Complete reference of the virtualNetwork API.
link: https://developer.cisco.com/docs/identity-services-engine/v1/#!trustsec-openapi
notes:
- SDK Method used are
virtual_network.VirtualNetwork.create_virtual_network,
virtual_network.VirtualNetwork.delete_virtual_network_by_id,
virtual_network.VirtualNetwork.update_virtual_network_by_id,
- Paths used are
post /api/v1/trustsec/virtualnetwork,
delete /api/v1/trustsec/virtualnetwork/{id},
put /api/v1/trustsec/virtualnetwork/{id},
"""
EXAMPLES = r"""
- name: Create
cisco.ise.trustsec_vn:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
additionalAttributes: string
id: string
lastUpdate: string
name: string
- name: Update by id
cisco.ise.trustsec_vn:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
additionalAttributes: string
id: string
lastUpdate: string
name: string
- name: Delete by id
cisco.ise.trustsec_vn:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
"""
RETURN = r"""
ise_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
type: list
elements: dict
sample: >
[
{
"additionalAttributes": "string",
"id": "string",
"lastUpdate": "string",
"name": "string"
}
]
ise_update_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
type: dict
sample: >
{
"code": 0,
"message": "string"
}
"""