check_point.mgmt.cp_mgmt_show_commands module – Retrieve all of the supported Management API commands with their description.

Note

This module is part of the check_point.mgmt collection (version 5.1.1).

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_show_commands.

New in check_point.mgmt 5.0.0

Synopsis

  • Retrieve all of the supported Management API commands with their description.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

prefix

string

The prefix of the desired commands to show.

version

string

Version of checkpoint. If not given one, the latest version taken.

wait_for_task

boolean

Wait for the task to end. Such as publish task.

Choices:

  • false

  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: show-commands
  cp_mgmt_show_commands:

Return Values

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

Key

Description

cp_mgmt_show_commands

dictionary

The checkpoint show-commands output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)