cp_mgmt_tacacs_server

Manages tacacs-server objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_tacacs_server

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages tacacs-server objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
color	str			Color of the object. Should be one of existing colors.
comments	str			Comments string.
details_level	str			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.
encryption	bool			Is there a secret key defined on the server. Must be set true when “server-type” was selected to be “TACACS+”.
groups	list			Collection of group identifiers.
ignore_errors	bool			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.
ignore_warnings	bool			Apply changes ignoring warnings.
name	str	yes		Object name.
priority	int			The priority of the TACACS Server in case it is a member of a TACACS Group.
secret_key	str			The server’s secret key. Required only when “server-type” was selected to be “TACACS+”.
server	str			The UID or Name of the host that is the TACACS Server.
server_type	str			Server type, TACACS or TACACS+.
service	str			Server service, only relevant when “server-type” is TACACS.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
version	str			Management API version path; omitted uses the default API version.
wait_for_task	bool		`true`	Wait for returned asynchronous task identifiers; default true.
wait_for_task_timeout	int		`30`	Polling deadline in minutes; default 30, negative values use 30, maximum 1440.

Example

yaml

- name: add-tacacs-server
  check_point.mgmt.cp_mgmt_tacacs_server:
    name: tacacs7
    server: h1
    state: present

- name: set-tacacs-server
  check_point.mgmt.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
  check_point.mgmt.cp_mgmt_tacacs_server:
    name: tacacs server
    state: absent