check_point.mgmt.cp_mgmt_set_session module – Edit user’s current session.

Note

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

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

New in version 2.9: of check_point.mgmt

Synopsis

  • Edit user’s current session.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

color

string

Color of the object. Should be one of existing colors.

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

comments

string

Comments string.

description

string

Session description.

details_level

string

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.

Choices:

  • uid

  • standard

  • full

ignore_errors

boolean

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.

Choices:

  • no

  • yes

ignore_warnings

boolean

Apply changes ignoring warnings.

Choices:

  • no

  • yes

new_name

string

New name of the object.

tags

list / elements=string

Collection of tag identifiers.

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:

  • no

  • yes ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: set-session
  cp_mgmt_set_session:
    description: Session to work on ticket number CR00323665
    state: present

Return Values

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

Key

Description

cp_mgmt_set_session

dictionary

The checkpoint set-session output.

Returned: always.

Authors

  • Or Soffer (@chkp-orso)