cisco.ise.pan_ha – Resource module for Pan Ha

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.pan_ha.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operations create and delete of the resource Pan Ha.

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
failedAttempts
integer
Pan Ha's failedAttempts.
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.
isEnabled
boolean
    Choices:
  • no
  • yes
IsEnabled flag.
pollingInterval
integer
Pan Ha's pollingInterval.
primaryHealthCheckNode
string
Pan Ha's primaryHealthCheckNode.
secondaryHealthCheckNode
string
Pan Ha's secondaryHealthCheckNode.

Notes

Note

  • Does not support check_mode

See Also

See also

Pan Ha reference

Complete reference of the Pan Ha object model.

Examples

- name: Create
  cisco.ise.pan_ha:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    failedAttempts: 0
    isEnabled: true
    pollingInterval: 0
    primaryHealthCheckNode: string
    secondaryHealthCheckNode: string

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

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:
{ "isEnabled": true, "primaryHealthCheckNode": "string", "secondaryHealthCheckNode": "string", "pollingInterval": 0, "failedAttempts": 0 }


Authors

  • Rafael Campos (@racampos)