cisco.ise.tacacs_server_sequence – Resource module for Tacacs Server Sequence

Note

This plugin is part of the cisco.ise collection (version 1.2.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.tacacs_server_sequence.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operations create, update and delete of the resource Tacacs Server Sequence.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.1.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
description
string
Tacacs Server Sequence's description.
id
string
Tacacs Server Sequence's id.
ise_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
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
    Choices:
  • no
  • yes ←
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).
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.1.0"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
localAccounting
boolean
    Choices:
  • no
  • yes
LocalAccounting flag.
name
string
Tacacs Server Sequence's name.
prefixDelimiter
string
The delimiter that will be used for prefix strip.
prefixStrip
boolean
    Choices:
  • no
  • yes
Define if a delimiter will be used for prefix strip.
remoteAccounting
boolean
    Choices:
  • no
  • yes
RemoteAccounting flag.
serverList
string
The names of Tacacs external servers separated by commas. The order of the names in the string is the order of servers that will be used during authentication.
suffixDelimiter
string
The delimiter that will be used for suffix strip.
suffixStrip
boolean
    Choices:
  • no
  • yes
Define if a delimiter will be used for suffix strip.

Notes

Note

  • Does not support check_mode

See Also

See also

Tacacs Server Sequence reference

Complete reference of the Tacacs Server Sequence object model.

Examples

- name: Update by id
  cisco.ise.tacacs_server_sequence:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    id: string
    localAccounting: true
    name: string
    prefixDelimiter: string
    prefixStrip: true
    remoteAccounting: true
    serverList: string
    suffixDelimiter: string
    suffixStrip: true

- name: Delete by id
  cisco.ise.tacacs_server_sequence:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

- name: Create
  cisco.ise.tacacs_server_sequence:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    localAccounting: true
    name: string
    prefixDelimiter: string
    prefixStrip: true
    remoteAccounting: true
    serverList: string
    suffixDelimiter: string
    suffixStrip: true

Return Values

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

Key Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "id": "string", "name": "string", "description": "string", "serverList": "string", "localAccounting": true, "remoteAccounting": true, "prefixStrip": true, "prefixDelimiter": "string", "suffixStrip": true, "suffixDelimiter": "string", "link": { "rel": "string", "href": "string", "type": "string" } }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }


Authors

  • Rafael Campos (@racampos)