check_point.mgmt.cp_mgmt_show_api_settings (5.2.3) — module

Retrieve API Settings.

| "added in version" 5.0.0 of check_point.mgmt"

Authors: Eden Brillant (@chkp-edenbr)

preview | supported by community

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3


Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

Retrieve API Settings. This command is available only after logging in to the System Data domain.

All operations are performed over Web Services API.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show-api-settings
  cp_mgmt_show_api_settings:

Inputs

    
version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_show_api_settings:
  description: The checkpoint show-api-settings output.
  returned: always.
  type: dict