cisco.ise.repository module – Resource module for Repository

Note

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

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

New in cisco.ise 1.0.0

Synopsis

• Manage operations create, update and delete of the resource Repository.

• Create a new repository in the system. The name provided for the repository must be unique.

• Long description TBD.

• Update the definition of a specific repository, providing ALL parameters for the repository.

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
enablePki boolean	EnablePki flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :ansible-option-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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: :ansible-option-default:`"3.1\_Patch\_1"`
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
name string	Repository name should be less than 80 characters and can contain alphanumeric, underscore, hyphen and dot characters.
password string	Password can contain alphanumeric and/or special characters.
path string	Path should always start with “/” and can contain alphanumeric, underscore, hyphen and dot characters.
protocol string	Repository’s protocol.
repositoryName string	RepositoryName path parameter. Unique name for a repository.
serverName string	Repository’s serverName.
userName string	Username may contain alphanumeric and _-./@\\$ characters.

Notes

Note

• SDK Method used are repository.Repository.create_repository, repository.Repository.delete_repository, repository.Repository.update_repository,

• Paths used are post /api/v1/repository, delete /api/v1/repository/{repositoryName}, put /api/v1/repository/{repositoryName},

• 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

See Also

See also

Cisco ISE documentation for Repository

Complete reference of the Repository API.

Examples

- name: Create
  cisco.ise.repository:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    enablePki: true
    name: string
    password: string
    path: string
    protocol: string
    serverName: string
    userName: string

- name: Update by name
  cisco.ise.repository:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    enablePki: true
    name: string
    password: string
    path: string
    protocol: string
    repositoryName: string
    serverName: string
    userName: string

- name: Delete by name
  cisco.ise.repository:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    repositoryName: 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: :ansible-rv-sample-value:`{"enablePki": true, "name": "string", "password": "string", "path": "string", "protocol": "string", "serverName": "string", "userName": "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: :ansible-rv-sample-value:`{"success": {"message": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)