check_point.mgmt.cp_mgmt_set_outbound_inspection_certificate module – Edit outbound-inspection-certificate

Note

This module is part of the check_point.mgmt collection (version 6.5.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_outbound_inspection_certificate.

New in check_point.mgmt 6.0.0

Synopsis

  • Edit outbound-inspection-certificate

  • All operations are performed over Web Services API.

  • Available from R81.20 management version.

Parameters

Parameter

Comments

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

base64_password

string

Password (encoded in Base64 with padding) for the certificate file.<br><font color=”red”>Required only if</font> one of the following parameters is given, issued-by, valid-from, valid-to.

Available from R82 management version.

color

string

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

Available from R82 management version.

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.

Available from R82 management version.

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.

Available from R82 management version.

Choices:

  • false

  • true

ignore_warnings

boolean

Apply changes ignoring warnings.

Available from R82 management version.

Choices:

  • false

  • true

is_default

boolean

Is the certificate the default certificate.

Available from R82 management version.

Choices:

  • false

  • true

issued_by

string

The DN (Distinguished Name) of the certificate.<br><font color=”red”>Required only if</font> one of the following parameters is given, base64-password, valid-from, valid-to.

Available from R82 management version.

name

string / required

Object name.

tags

list / elements=string

Collection of tag identifiers.

Available from R82 management version.

valid_from

string

The date, from which the certificate is valid. Format, YYYY-MM-DD.<br><font color=”red”>Required only if</font> one of the following parameters is given, issued-by, base64-password, valid-to.

Available from R82 management version.

valid_to

string

The certificate expiration date. Format, YYYY-MM-DD.<br><font color=”red”>Required only if</font> one of the following parameters is given, issued-by, base64-password, valid-from.

Available from R82 management version.

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:

  • false

  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: set-outbound-inspection-certificate
  cp_mgmt_set_outbound_inspection_certificate:
    base64_password: bXlfcGFzc3dvcmQ=
    is_default: 'false'
    issued_by: www.checkpoint.com
    name: OutboundCertificate
    valid_from: '2021-04-17'
    valid_to: '2028-04-17'

Return Values

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

Key

Description

cp_mgmt_set_outbound_inspection_certificate

dictionary

The checkpoint set-outbound-inspection-certificate output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)