cisco.ise.trustsec_sg_vn_mapping module – Resource module for Trustsec SG VN Mapping
Note
This module is part of the cisco.ise collection (version 2.9.5).
To install it, use: ansible-galaxy collection install cisco.ise
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.trustsec_sg_vn_mapping
.
New in cisco.ise 2.0.0
Synopsis
Manage operations create, update and delete of the resource Trustsec SG VN Mapping.
Create Security Group and Virtual Network mapping.
Delete Security Group and Virtual Network mapping.
Update Security Group and Virtual Network mapping.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.2.3
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Identifier of the SG-VN mapping. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices: |
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: :ansible-option-default:`60` |
|
The Identity Services Engine username to authenticate. |
|
Flag that informs the SDK whether to use the Identity Services Engine’s API Gateway to send requests. If it is true, it uses the ISE’s API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). Choices: |
|
Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices: |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Identity Services Engine to use. |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: |
|
Timestamp for the last update of the SG-VN mapping. |
|
Name of the associated Security Group to be used for identity if id is not provided. |
|
Identifier of the associated Security Group which is required unless its name is provided. |
|
Identifier for the associated Virtual Network which is required unless its name is provided. |
|
Name of the associated Virtual Network to be used for identity if id is not provided. |
Notes
Note
SDK Method used are sg_vn_mapping.SgVnMapping.create_sg_vn_mapping, sg_vn_mapping.SgVnMapping.delete_sg_vn_mapping, sg_vn_mapping.SgVnMapping.update_sg_vn_mapping,
Paths used are post /api/v1/trustsec/sgvnmapping, delete /api/v1/trustsec/sgvnmapping/{id}, put /api/v1/trustsec/sgvnmapping/{id},
Does not support
check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK
The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection
See Also
See also
- Cisco ISE documentation for sgVnMapping
Complete reference of the sgVnMapping API.
Examples
- name: Create
cisco.ise.trustsec_sg_vn_mapping:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
id: string
lastUpdate: string
sgName: string
sgtId: string
vnId: string
vnName: string
- name: Update by id
cisco.ise.trustsec_sg_vn_mapping:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
id: string
lastUpdate: string
sgName: string
sgtId: string
vnId: string
vnName: string
- name: Delete by id
cisco.ise.trustsec_sg_vn_mapping:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always |