cisco.ise.trustsec_vn_vlan_mapping_bulk_create module – Resource module for Trustsec Vn Vlan Mapping Bulk Create

Note

This module is part of the cisco.ise collection (version 2.3.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.trustsec_vn_vlan_mapping_bulk_create.

New in version 2.0.0: of cisco.ise

Synopsis

• Manage operation create of the resource Trustsec Vn Vlan Mapping Bulk Create.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• ciscoisesdk >= 2.0.1

• python >= 3.5

Parameters

Parameter	Comments
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: no ← (default) yes
ise_hostname string / required	The Identity Services Engine hostname.
ise_password string / required	The Identity Services Engine password to authenticate.
ise_username string / required	The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in 1.1.0 of cisco.ise	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: no yes ← (default)
ise_uses_csrf_token boolean added in 3.0.0 of cisco.ise	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: no ← (default) yes
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: “3.1.1”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
payload list / elements=dictionary	Trustsec Vn Vlan Mapping Bulk Create’s payload.
id string	Identifier of the VN-Vlan Mapping.
isData boolean	Flag which indicates whether the Vlan is data or voice type. Choices: no yes
isDefaultVlan boolean	Flag which indicates if the Vlan is default. Choices: no yes
lastUpdate string	Timestamp for the last update of the VN-Vlan Mapping.
maxValue integer	Max value.
name string	Name of the Vlan.
vnId string	Identifier for the associated Virtual Network which is required unless its name is provided.
vnName string	Name of the associated Virtual Network to be used for identity if id is not provided.

Notes

Note

• SDK Method used are vn_vlan_mapping.VnVlanMapping.bulk_create_vn_vlan_mappings,

• Paths used are post /api/v1/trustsec/vnvlanmapping/bulk/create,

• 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

Examples

- name: Create
  cisco.ise.trustsec_vn_vlan_mapping_bulk_create:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    payload:
    - id: string
      isData: true
      isDefaultVlan: true
      lastUpdate: string
      maxValue: 1
      name: string
      vnId: string
      vnName: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
ise_response dictionary	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “{\n \”id\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)