check_point.mgmt.cp_mgmt_tacacs_server module – Manages tacacs-server objects on Checkpoint over Web Services API
Note
This module is part of the check_point.mgmt collection (version 5.2.3).
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 check_point.mgmt
.
To use it in a playbook, specify: check_point.mgmt.cp_mgmt_tacacs_server
.
New in check_point.mgmt 5.0.0
Synopsis
Manages tacacs-server objects on Checkpoint devices including creating, updating and removing objects.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Color of the object. Should be one of existing colors. Choices:
|
|
Comments string. |
|
The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object. Choices:
|
|
Is there a secret key defined on the server. Must be set true when “server-type” was selected to be “TACACS+”. Choices:
|
|
Collection of group identifiers. |
|
Apply changes ignoring errors. You won’t be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored. Choices:
|
|
Apply changes ignoring warnings. Choices:
|
|
Object name. |
|
The priority of the TACACS Server in case it is a member of a TACACS Group. |
|
The server’s secret key.<br><font color=”red”>Required only when</font> “server-type” was selected to be “TACACS+”. |
|
The UID or Name of the host that is the TACACS Server. |
|
Server type, TACACS or TACACS+. Choices:
|
|
Server service, only relevant when “server-type” is TACACS. |
|
State of the access rule (present or absent). Choices:
|
|
Collection of tag identifiers. |
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: |
Examples
- name: add-tacacs-server
cp_mgmt_tacacs_server:
name: tacacs7
server: h1
state: present
- name: set-tacacs-server
cp_mgmt_tacacs_server:
encryption: 'true'
name: tacacs server
priority: '5'
secret_key: '**secret**'
server: d700e8d5-d010-4f37-ab14-f78f5a26426c
server_type: TACACS
state: present
- name: delete-tacacs-server
cp_mgmt_tacacs_server:
name: tacacs server
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint object created or updated. Returned: always, except when deleting the object. |