cisco.ise.endpoints_bulk module – Resource module for Endpoints Bulk

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.ise 1.0.0

Synopsis 

Manage operations create, update and delete of the resource Endpoints Bulk.

Note

This module has a corresponding action plugin.

Requirements 

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

ciscoisesdk >= 2.2.0
python >= 3.5

Parameters 

Parameter	Comments
connectedLinks dictionary	Endpoints Bulk’s connectedLinks.
customAttributes dictionary	Endpoints Bulk’s customAttributes.
description string	Endpoints Bulk’s description.
deviceType string	Endpoints Bulk’s deviceType.
groupId string	Endpoints Bulk’s groupId.
hardwareRevision string	Endpoints Bulk’s hardwareRevision.
id string	Endpoints Bulk’s id.
identityStore string	Endpoints Bulk’s identityStore.
identityStoreId string	Endpoints Bulk’s identityStoreId.
ipAddress string	Endpoints Bulk’s ipAddress.
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: `false` ← (default) `true`
ise_hostname string / required	The Identity Services Engine hostname.
ise_password string / required	The Identity Services Engine password to authenticate.
ise_single_request_timeout integer added in cisco.ise 3.0.0	Timeout (in seconds) for RESTful HTTP requests. Default: `60`
ise_username string / required	The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in cisco.ise 1.1.0	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: `false` `true` ← (default)
ise_uses_csrf_token boolean added in cisco.ise 3.0.0	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: `false` ← (default) `true`
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: `false` `true` ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: `false` `true` ← (default)
mac string	Endpoints Bulk’s mac.
mdmAttributes dictionary	Endpoints Bulk’s mdmAttributes.
name string	Endpoints Bulk’s name.
payload list / elements=dictionary	Endpoints Bulk’s payload.
connectedLinks dictionary	Endpoints Bulk’s connectedLinks.
customAttributes dictionary	Endpoints Bulk’s customAttributes.
description string	Endpoints Bulk’s description.
deviceType string	Endpoints Bulk’s deviceType.
groupId string	Endpoints Bulk’s groupId.
hardwareRevision string	Endpoints Bulk’s hardwareRevision.
id string	Endpoints Bulk’s id.
identityStore string	Endpoints Bulk’s identityStore.
identityStoreId string	Endpoints Bulk’s identityStoreId.
ipAddress string	Endpoints Bulk’s ipAddress.
mac string	Endpoints Bulk’s mac.
mdmAttributes dictionary	Endpoints Bulk’s mdmAttributes.
name string	Endpoints Bulk’s name.
portalUser string	Endpoints Bulk’s portalUser.
productId string	Endpoints Bulk’s productId.
profileId string	Endpoints Bulk’s profileId.
protocol string	Endpoints Bulk’s protocol.
serialNumber string	Endpoints Bulk’s serialNumber.
softwareRevision string	Endpoints Bulk’s softwareRevision.
staticGroupAssignment boolean	StaticGroupAssignment flag. Choices: `false` `true`
staticProfileAssignment boolean	StaticProfileAssignment flag. Choices: `false` `true`
vendor string	Endpoints Bulk’s vendor.
portalUser string	Endpoints Bulk’s portalUser.
productId string	Endpoints Bulk’s productId.
profileId string	Endpoints Bulk’s profileId.
protocol string	Endpoints Bulk’s protocol.
serialNumber string	Endpoints Bulk’s serialNumber.
softwareRevision string	Endpoints Bulk’s softwareRevision.
staticGroupAssignment boolean	StaticGroupAssignment flag. Choices: `false` `true`
staticProfileAssignment boolean	StaticProfileAssignment flag. Choices: `false` `true`
value string	Value path parameter. The id or MAC of the endpoint.
vendor string	Endpoints Bulk’s vendor.

Notes 

Note

SDK Method used are endpoints.Endpoints.create_bulk_end_points, endpoints.Endpoints.delete_endpoint, endpoints.Endpoints.update_bulk_end_points, endpoints.Endpoints.update_endpoint,
Paths used are post /api/v1/endpoint, post /api/v1/endpoint/bulk, delete /api/v1/endpoint/bulk, delete /api/v1/endpoint/{value}, put /api/v1/endpoint/bulk, put /api/v1/endpoint/{value},
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.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    payload:
    - connectedLinks: {}
      customAttributes: {}
      description: string
      deviceType: string
      groupId: string
      hardwareRevision: string
      id: string
      identityStore: string
      identityStoreId: string
      ipAddress: string
      mac: string
      mdmAttributes: {}
      name: string
      portalUser: string
      productId: string
      profileId: string
      protocol: string
      serialNumber: string
      softwareRevision: string
      staticGroupAssignment: true
      staticProfileAssignment: true
      vendor: string

- name: Update all
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    payload:
    - connectedLinks: {}
      customAttributes: {}
      description: string
      deviceType: string
      groupId: string
      hardwareRevision: string
      id: string
      identityStore: string
      identityStoreId: string
      ipAddress: string
      mac: string
      mdmAttributes: {}
      name: string
      portalUser: string
      productId: string
      profileId: string
      protocol: string
      serialNumber: string
      softwareRevision: string
      staticGroupAssignment: true
      staticProfileAssignment: true
      vendor: string

- name: Delete all
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent

- name: Update by id
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    connectedLinks: {}
    customAttributes: {}
    description: string
    deviceType: string
    groupId: string
    hardwareRevision: string
    id: string
    identityStore: string
    identityStoreId: string
    ipAddress: string
    mac: string
    mdmAttributes: {}
    name: string
    portalUser: string
    productId: string
    profileId: string
    protocol: string
    serialNumber: string
    softwareRevision: string
    staticGroupAssignment: true
    staticProfileAssignment: true
    value: string
    vendor: string

- name: Delete by id
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    value: 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: {"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}

ise_update_response

dictionary

added in cisco.ise 1.1.0

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: {"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}

Authors

Rafael Campos (@racampos)

cisco.ise.endpoints_bulk module – Resource module for Endpoints Bulk

Synopsis

Requirements

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

Examples 

Return Values 