ansible.builtin.cp_mgmt_service_sctp (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Manages service-sctp objects on Check Point 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-service-sctp
  cp_mgmt_service_sctp:
    aggressive_aging:
      enable: true
      timeout: 360
      use_default_timeout: false
    keep_connections_open_after_policy_installation: false
    match_for_any: true
    name: New_SCTP_Service_1
    port: 5669
    session_timeout: 0
    state: present
    sync_connections_on_cluster: true

Scanned by Steampunk Spotter

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

- name: set-service-sctp
  cp_mgmt_service_sctp:
    aggressive_aging:
      default_timeout: 3600
    color: green
    name: New_SCTP_Service_1
    port: 5656
    state: present

Scanned by Steampunk Spotter

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

- name: delete-service-sctp
  cp_mgmt_service_sctp:
    name: New_SCTP_Service_2
    state: absent

Inputs

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

port:
    description:
    - Port number. To specify a port range add a hyphen between the lowest and the highest
      port numbers, for example 44-45.
    type: str

tags:
    description:
    - Collection of tag identifiers.
    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.
    type: list

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

comments:
    description:
    - Comments string.
    type: str

source_port:
    description:
    - Source port number. To specify a port range add a hyphen between the lowest and
      the highest port numbers, for example 44-45.
    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

match_for_any:
    description:
    - Indicates whether this service is used when 'Any' is set as the rule's service and
      there are several service objects with the same source port and protocol.
    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

session_timeout:
    description:
    - Time (in seconds) before the session times out.
    type: int

aggressive_aging:
    description:
    - Sets short (aggressive) timeouts for idle connections.
    suboptions:
      default_timeout:
        description:
        - Default aggressive aging timeout in seconds.
        type: int
      enable:
        description:
        - N/A
        type: bool
      timeout:
        description:
        - Aggressive aging timeout in seconds.
        type: int
      use_default_timeout:
        description:
        - N/A
        type: bool
    type: dict

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

sync_connections_on_cluster:
    description:
    - Enables state-synchronized High Availability or Load Sharing on a ClusterXL or OPSEC-certified
      cluster.
    type: bool

use_default_session_timeout:
    description:
    - Use default virtual session timeout.
    type: bool

keep_connections_open_after_policy_installation:
    description:
    - Keep connections open after policy has been installed even if they are not allowed
      under the new policy. This overrides the settings in the Connection Persistence
      page. If you change this property, the change will not affect open connections,
      but only future connections.
    type: bool

Outputs

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