cp_mgmt_passcode_profile

Manages passcode-profile 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_passcode_profile

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

Synopsis

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

Parameters

Name	Type	Required	Default	Description
allow_simple_passcode	bool			The passcode length is 4 and only numeric values allowed.
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.
domains_to_process	list			Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
enable_inactivity_time_lock	bool			Lock the device if app is inactive.
enable_passcode_failed_attempts	bool			Exit after few failures in passcode verification.
enable_passcode_history	bool			Check passcode history for reparations.
force_passcode_expiration	bool			Enable/disable expiration date to the passcode.
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.
max_inactivity_time_lock	int			Time without user input before passcode must be re-entered (in minutes).
max_passcode_failed_attempts	int			Number of failed attempts allowed.
min_passcode_complex_characters	int			Minimum number of complex characters (if “require-alphanumeric-passcode” is enabled). The number of the complex characters cannot be greater than number of the passcode length.
min_passcode_length	int			Minimum passcode length - relevant if “allow-simple-passcode” is disable.
name	str	yes		Object name.
passcode_expiration_period	int			The period in days after which the passcode will expire.
passcode_history	int			Number of passcodes that will be kept in history.
require_alphanumeric_passcode	bool			Require alphanumeric characters in the passcode - relevant if “allow-simple-passcode” is disable.
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-passcode-profile
  check_point.mgmt.cp_mgmt_passcode_profile:
    name: New App Passcode Policy
    state: present

- name: set-passcode-profile
  check_point.mgmt.cp_mgmt_passcode_profile:
    allow_simple_passcode: 'true'
    max_inactivity_time_lock: '30'
    name: New App Passcode Policy
    require_alphanumeric_passcode: 'false'
    state: present

- name: delete-passcode-profile
  check_point.mgmt.cp_mgmt_passcode_profile:
    name: My App Passcode Policy
    state: absent