- Docs »
- check_point.mgmt.cp_mgmt_set_session – Edit user’s current session.
-
You are reading the latest community version of the Ansible documentation. Red Hat subscribers, select 2.9 in the version selection to the left for the most recent Red Hat release.
check_point.mgmt.cp_mgmt_set_session – Edit user’s current session.
Note
This plugin is part of the check_point.mgmt collection (version 2.0.0).
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
Parameter |
Choices/Defaults |
Comments |
color
string
|
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
|
Color of the object. Should be one of existing colors.
|
comments
string
|
|
Comments string.
|
description
string
|
|
Session description.
|
details_level
string
|
Choices:
- uid
- standard
- full
|
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.
|
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.
|
ignore_warnings
boolean
|
|
Apply changes ignoring warnings.
|
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.
|
wait_for_task_timeout
integer
|
Default:
30
|
How many minutes to wait until throwing a timeout error.
|
- name: set-session
cp_mgmt_set_session:
description: Session to work on ticket number CR00323665
state: present
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
cp_mgmt_set_session
dictionary
|
always. |
The checkpoint set-session output.
|