check_point.mgmt.cp_mgmt_lsm_gateway (5.2.3) — module

Manages lsm-gateway objects on Checkpoint over Web Services API

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

Authors: Shiran Golzar (@chkp-shirango)

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

Manages lsm-gateway objects on Checkpoint devices including creating, updating and removing objects.

All operations are performed over Web Services API.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: add-lsm-gateway
  cp_mgmt_lsm_gateway:
    name: lsm_gateway
    provisioning_settings:
      provisioning_profile: prv_profile
    provisioning_state: using-profile
    security_profile: lsm_profile
    sic:
      ip_address: 1.2.3.4
      one_time_password: aaaa
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: set-lsm-gateway
  cp_mgmt_lsm_gateway:
    name: lsm_gateway
    provisioning_settings:
      provisioning_profile: prv_profile
    provisioning_state: using-profile
    security_profile: lsm_profile
    sic:
      ip_address: 1.2.3.4
      one_time_password: aaaa
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete-lsm-gateway
  cp_mgmt_lsm_gateway:
    name: lsm_gateway
    state: absent

Inputs

    
sic:
    description:
    - Secure Internal Communication.
    suboptions:
      ip_address:
        description:
        - IP address. When IP address is provided- initiate trusted communication immediately
          using this IP address.
        type: str
      one_time_password:
        description:
        - One-time password. When one-time password is provided without ip-address- trusted
          communication is automatically initiated  when the gateway connects to the Security
          Management server for the first time.
        type: str
    type: dict

name:
    description:
    - Object name.
    required: true
    type: str

color:
    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
    description:
    - Color of the object. Should be one of existing colors.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the access rule (present or absent).
    type: str

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

comments:
    description:
    - Comments string.
    type: str

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - 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.
    type: str

ignore_errors:
    description:
    - 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.
    type: bool

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

ignore_warnings:
    description:
    - Apply changes ignoring warnings.
    type: bool

security_profile:
    description:
    - LSM profile.
    type: str

provisioning_state:
    choices:
    - 'off'
    - manual
    - using-profile
    description:
    - Provisioning state. By default the state is 'manual'- enable provisioning but not
      attach to profile.
    - If 'using-profile' state is provided a provisioning profile must be provided in
      provisioning-settings.
    type: str

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

provisioning_settings:
    description:
    - Provisioning settings.
    suboptions:
      provisioning_profile:
        description:
        - Provisioning profile.
        type: str
    type: dict

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

Outputs

cp_mgmt_lsm_gateway:
  description: The checkpoint object created or updated.
  returned: always, except when deleting the object.
  type: dict