cp_mgmt_resource_smtp
Manages resource-smtp objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_resource_smtp
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages resource-smtp objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| action_1 | dict | Use the Rewriting Rules to rewrite Sender and Recipient headers in emails, you can also rewrite other email headers by using the custom header field. | ||
| action_2 | dict | Use this window to configure mail inspection for the SMTP Resource. | ||
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| check_rulebase_with_new_destination | bool | The Rule Base will be rechecked with the new resolved IP address for mail delivery. | ||
| color | str | Color of the object. Should be one of existing colors. | ||
| comments | str | Comments string. | ||
| cvp | dict | Configure CVP inspection on mail messages. | ||
| deliver_messages_using_dns_mx_records | bool | MX record resolving is used to set the destination IP address of the connection. | ||
| details_level | str | 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. | ||
| error_check_rulebase_with_new_destination | bool | The Rule Base will be rechecked with the new resolved IP address for error mail delivery. | ||
| error_deliver_messages_using_dns_mx_records | bool | MX record resolving will be used to set the source IP address of the connection used to send the error message. | ||
| error_mail_delivery_server | str | Error mail delivery happens if the SMTP security server is unable to deliver the message within the abandon time, and Notify Sender on Error is checked. | ||
| exception_track | str | Determines if an action specified in the Action 2 and CVP categories taken as a result of a resource definition is logged. | ||
| ignore_errors | bool | 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 | bool | Apply changes ignoring warnings. | ||
| mail_delivery_server | str | Specify the server to which mail is forwarded. | ||
| match | dict | Set the Match properties for the SMTP resource. | ||
| name | str | yes | Object name. | |
| notify_sender_on_error | bool | Enable error mail delivery. | ||
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. |
Example
yaml
- name: add-resource-smtp
check_point.mgmt.cp_mgmt_resource_smtp:
deliver_messages_using_dns_mx_records: 'true'
exception_track: exception log
mail_delivery_server: deliverServer
match:
recipient: recipientName
sender: senderName
name: newSmtpResource
state: present
- name: set-resource-smtp
check_point.mgmt.cp_mgmt_resource_smtp:
mail_delivery_server: newServer
name: newSmtpResource
state: present
- name: delete-resource-smtp
check_point.mgmt.cp_mgmt_resource_smtp:
name: newSmtpResource
state: absent