cp_mgmt_security_zone – Manages security-zone objects on Check Point over Web Services API

From Get docs
Ansible/docs/2.9/modules/cp mgmt security zone module


cp_mgmt_security_zone – Manages security-zone objects on Check Point over Web Services API

New in version 2.9.


Synopsis

  • Manages security-zone 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

  • no
  • yes

Publish the current session if changes have been performed after task completes.

color

string

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

details_level

string

  • 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

  • no
  • yes

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

  • no
  • yes

Apply changes ignoring warnings.

name

string / required

Object name.

state

string

  • present

  • absent

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

  • no
  • yes

Wait for the task to end. Such as publish task.



Examples

- name: add-security-zone
  cp_mgmt_security_zone:
    color: yellow
    comments: My Security Zone 1
    name: SZone1
    state: present

- name: set-security-zone
  cp_mgmt_security_zone:
    name: SZone1
    state: present

- name: delete-security-zone
  cp_mgmt_security_zone:
    name: SZone2
    state: absent

Return Values

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

Key Returned Description

cp_mgmt_security_zone

dictionary

always, except when deleting the object.

The checkpoint object created or updated.





Status

Authors

  • Or Soffer (@chkp-orso)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/cp_mgmt_security_zone_module.html