check_point.mgmt.cp_mgmt_lsv_profile (5.2.3) — module

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 lsv-profile objects on Checkpoint devices including creating, updating and removing objects.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: add-lsv-profile
  cp_mgmt_lsv_profile:
    certificate_authority: dedicated_profile_certificate
    name: New lsv-profile
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: set-lsv-profile
  cp_mgmt_lsv_profile:
    certificate_authority: another CA
    name: existing lsv-profile
    restrict_allowed_addresses: 'false'
    state: present
    vpn_domain:
      limit_peer_domain_size: 'false'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: delete-lsv-profile
  cp_mgmt_lsv_profile:
    name: existing lsv-profile
    state: absent

Inputs

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

tags:
    description:
    - Collection of tag identifiers.
    elements: str
    type: list

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

groups:
    description:
    - Collection of group identifiers.
    elements: str
    type: list

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

comments:
    description:
    - Comments string.
    type: str

vpn_domain:
    description:
    - peers' VPN Domain properties.
    suboptions:
      limit_peer_domain_size:
        description:
        - Use this parameter to limit the number of IP addresses in the VPN Domain of
          each peer according to the value in the max-allowed-addresses field.
        type: bool
      max_allowed_addresses:
        description:
        - Maximum number of IP addresses in the VPN Domain of each peer. This value will
          be enforced only when limit-peer-domain-size field is set to true. Select a
          value between 1 and 256. Default value is 256.
        type: int
    type: dict

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

allowed_ip_addresses:
    description:
    - Collection of network objects identified by name or UID that represent IP addresses
      allowed in profile's VPN domain.
    elements: str
    type: list

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

certificate_authority:
    description:
    - Trusted Certificate authority for establishing trust between VPN peers, identified
      by name or UID.
    type: str

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

restrict_allowed_addresses:
    description:
    - Indicate whether the IP addresses allowed in the VPN Domain will be restricted or
      not, according to allowed-ip-addresses field.
    type: bool

Outputs

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