check_point.mgmt.cp_mgmt_gsn_handover_group module – Manages gsn-handover-group objects on Checkpoint over Web Services API
Note
This module is part of the check_point.mgmt collection (version 6.2.1).
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_gsn_handover_group
.
New in check_point.mgmt 5.0.0
Synopsis
Manages gsn-handover-group objects on Checkpoint devices including creating, updating and removing objects.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Color of the object. Should be one of existing colors. Choices:
|
|
Comments 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:
|
|
Enable enforce GTP signal packet rate limit from this group. Choices:
|
|
Collection of group identifiers. |
|
Limit of the GTP rate in PDU/sec. |
|
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:
|
|
Apply changes ignoring warnings. Choices:
|
|
Collection of GSN handover group members identified by the name or UID. |
|
Object name. |
|
State of the access rule (present or absent). Choices:
|
|
Collection of tag identifiers. |
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: |
Examples
- name: add-gsn-handover-group
cp_mgmt_gsn_handover_group:
enforce_gtp: true
gtp_rate: 2048
members:
- All_Internet
name: gsnhandovergroup
state: present
- name: set-gsn-handover-group
cp_mgmt_gsn_handover_group:
enforce_gtp: false
name: gsnhandovergroup
state: present
- name: delete-gsn-handover-group
cp_mgmt_gsn_handover_group:
name: gsnhandovergroup
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint object created or updated. Returned: always, except when deleting the object. |