cp_mgmt_tag – Manages tag objects on Check Point over Web Services API¶
New in version 2.9.
Synopsis¶
Manages tag objects on Check Point devices including creating, updating and removing objects.
All operations are performed over Web Services API.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
auto_publish_session
boolean
|
|
Publish the current session if changes have been performed after task completes.
|
color
string
|
|
Color of the object. Should be one of existing colors.
|
comments
string
|
Comments string.
|
|
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.
|
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.
|
name
string
/ required
|
Object name.
|
|
state
string
|
|
State of the access rule (present or absent). Defaults to present.
|
tags
list
|
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.
|
Examples¶
- name: add-tag
cp_mgmt_tag:
name: My New Tag1
state: present
tags:
- tag1
- tag2
- name: delete-tag
cp_mgmt_tag:
name: My New Tag1
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
cp_mgmt_tag
dictionary
|
always, except when deleting the object. |
The checkpoint object created or updated.
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
Or Soffer (@chkp-orso)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.