cisco.ise.subscriber module – Resource module for Subscriber
Note
This module is part of the cisco.ise collection (version 2.9.6).
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.subscriber.
New in cisco.ise 2.8.0
Synopsis
Manage operations create, update and delete of the resource Subscriber.
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 |
|---|---|
Subscriber is enabled or not. Choices: |
|
Friendly name for the subscriber. |
|
Identity Group(s). With more than one idGroups it needs to be comma seperated. |
|
IMEI to be attached to the subscriber. |
|
IMSI for Subscriber. |
|
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: |
|
KI. |
|
OPC. |
|
SubscriberId path parameter. Unique id for a subscriber object. |
Notes
Note
SDK Method used are subscriber.Subscriber.create_subscriber, subscriber.Subscriber.delete_subscriber, subscriber.Subscriber.update_subscriber,
Paths used are post /api/v1/fiveg/subscriber, delete /api/v1/fiveg/subscriber/{subscriberId}, put /api/v1/fiveg/subscriber/{subscriberId},
Does not support
check_modeThe 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.subscriber:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
enabled: true
friendlyName: string
identityGroups: string
imeis: string
imsi: string
ki: string
opc: string
- name: Update by id
cisco.ise.subscriber:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
enabled: true
friendlyName: string
identityGroups: string
imeis: string
ki: string
opc: string
subscriberId: string
- name: Delete by id
cisco.ise.subscriber:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
subscriberId: 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 |