cp_mgmt_administrator

Manages administrator 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_administrator

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

Synopsis

Manages administrator objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
authentication_method	str			Authentication method.
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.
email	str			Administrator email.
expiration_date	str			Format, YYYY-MM-DD, YYYY-mm-ddThh,mm,ss.
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.
multi_domain_profile	str			Administrator multi-domain profile.
must_change_password	bool			True if administrator must change password on the next login.
name	str	yes		Object name.
password	str			Administrator password.
password_hash	str			Administrator password hash.
permissions_profile	str			Permission profile
permissions_profile_list	list			Administrator permissions profile. Permissions profile should not be provided when multi-domain-profile is set to “Multi-Domain Super User” or “Domain Super User”. Used only in MDS.
phone_number	str			Administrator phone number.
radius_server	str			RADIUS server object identified by the name or UID. Must be set when “authentication-method” was selected to be “RADIUS”.
state	str		`present`	Desired object presence.
tacacs_server	str			TACACS server object identified by the name or UID. Must be set when “authentication-method” was selected to be “TACACS”.
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-administrator
  check_point.mgmt.cp_mgmt_administrator:
    authentication_method: check point password
    email: admin@gmail.com
    must_change_password: false
    name: admin
    password: secret
    permissions_profile: read write all
    phone_number: 1800-800-800
    state: present

- name: set-administrator
  check_point.mgmt.cp_mgmt_administrator:
    name: admin
    password: new secret
    permissions_profile: read only profile
    state: present

- name: delete-administrator
  check_point.mgmt.cp_mgmt_administrator:
    name: admin
    state: absent

- name: add-administrator-in-MDS
  check_point.mgmt.cp_mgmt_administrator:
    authentication_method: check point password
    email: admin@gmail.com
    must_change_password: false
    name: admin
    password: secret
    permissions_profile_list:
      - profile: read write all
        domain: dom1
    phone_number: 1800-800-800
    state: present