check_point.mgmt.cp_mgmt_administrator – Manages administrator objects on Checkpoint over Web Services API

Note

This plugin is part of the check_point.mgmt collection (version 1.0.6).

To install it use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_administrator.

New in version 2.9: of check_point.mgmt

Synopsis

• Manages administrator objects on Checkpoint devices including creating, updating and removing objects.

• All operations are performed over Web Services API.

Parameters

Parameter		Choices/Defaults	Comments
authentication_method string		Choices: undefined check point password os password securid radius tacacs ad authentication api key	Authentication method.
auto_publish_session boolean		Choices: no yes	Publish the current session if changes have been performed after task completes.
color string		Choices: aquamarine black blue crete blue burlywood cyan dark green khaki orchid dark orange dark sea green pink turquoise dark blue firebrick brown forest green gold dark gold gray dark gray light green lemon chiffon coral sea green sky blue magenta purple slate blue violet red navy blue olive orange red sienna yellow	Color of the object. Should be one of existing colors.
comments string			Comments string.
details_level string		Choices: uid standard full	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 string			Administrator email.
expiration_date string			Format, YYYY-MM-DD, YYYY-mm-ddThh,mm,ss.
ignore_errors boolean		Choices: no yes	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 boolean		Choices: no yes	Apply changes ignoring warnings.
multi_domain_profile string			Administrator multi-domain profile.
must_change_password boolean		Choices: no yes	True if administrator must change password on the next login.
name string / required			Object name.
password string			Administrator password.
password_hash string			Administrator password hash.
permissions_profile list / elements=string			Administrator permissions profile. Permissions profile should not be provided when multi-domain-profile is set to "Multi-Domain Super User" or "Domain Super User".
	profile string		Permission profile.
phone_number string			Administrator phone number.
radius_server string			RADIUS server object identified by the name or UID. Must be set when "authentication-method" was selected to be "RADIUS".
state string		Choices: present ← absent	State of the access rule (present or absent). Defaults to present.
tacacs_server string			TACACS server object identified by the name or UID. Must be set when "authentication-method" was selected to be "TACACS".
tags list / elements=string			Collection of tag identifiers.
version string			Version of checkpoint. If not given one, the latest version taken.
wait_for_task boolean		Choices: no yes ←	Wait for the task to end. Such as publish task.

Examples

- name: add-administrator
  cp_mgmt_administrator:
    authentication_method: INTERNAL_PASSWORD
    email: [email protected]
    must_change_password: false
    name: admin
    password: secret
    permissions_profile: read write all
    phone_number: 1800-800-800
    state: present

- name: set-administrator
  cp_mgmt_administrator:
    name: admin
    password: bew secret
    permissions_profile: read only profile
    state: present

- name: delete-administrator
  cp_mgmt_administrator:
    name: admin
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
cp_mgmt_administrator dictionary	always, except when deleting the object.	The checkpoint object created or updated.

Authors

• Or Soffer (@chkp-orso)