cpauto.objects package

Submodules

cpauto.objects.access module

This module contains the classes needed to manage access control and NAT objects.

class cpauto.objects.access.AccessLayer(core_client)[source]

Manage access layers.

add(name='', params={})[source]

Adds an access layer.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-access-layer

Parameters:
  • name – A name for the new access layer..
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing access layer with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-access-layer

Parameters:
  • name – (optional) The name of an existing access layer.
  • uid – (optional) The unique identifier of an existing access layer.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing access layer with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-access-layer

Parameters:
  • name – (optional) The name of an existing access layer.
  • uid – (optional) The unique identifier of an existing access layer.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of an access layer with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-access-layer

Parameters:
  • name – (optional) The name of an existing host.
  • uid – (optional) The unique identifier of an existing access layer.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all hosts with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-access-layers

Parameters:
  • limit – (optional) Limit the total number of access layers shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of access layers in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
class cpauto.objects.access.AccessRule(core_client)[source]

Manage access rules.

add(layer='', position='', params={})[source]

Adds an access rule within a layer.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-access-rule

Parameters:
  • layer – Layer that the rule belongs to identified by name or UID.
  • position (integer, string or dict (e.g. 1, 'top', 'bottom', or "{ 'above': 'Section One' }")) – Position in the rulebase. Can be specified in various ways.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(layer='', name='', uid='', params={})[source]

Deletes an existing access rule within a layer.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-access-rule

Parameters:
  • layer – Layer that the rule belongs to identified by name or UID.
  • name – (optional) The name of an existing access rule.
  • uid – (optional) The unique identifier of an existing access rule.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(layer='', name='', uid='', params={})[source]

Sets new values for an access rule within a layer.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-access-rule

Parameters:
  • layer – Layer that the rule belongs to identified by name or UID.
  • name – (optional) The name of an existing access rule.
  • uid – (optional) The unique identifier of an existing access rule.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(layer='', name='', uid='', params={})[source]

Shows details of an access rule within a layer.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-access-rule

Parameters:
  • layer – Layer that the rule belongs to identified by name or UID.
  • name – (optional) The name of an existing access rule.
  • uid – (optional) The unique identifier of an existing access rule.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show_all(name='', params={})[source]

Shows all access rules within a layer, section, etc.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-access-rulebase

Parameters:
  • name – The name of an existing access layer, section, etc.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
class cpauto.objects.access.AccessSection(core_client)[source]

Manage access sections.

add(layer='', position='', params={})[source]

Adds an access section within a layer.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-access-section

Parameters:
  • layer – Layer that the section belongs to identified by name or UID.
  • position (integer, string or dict (e.g. 1, 'top', 'bottom', or "{ 'above': 'Section One' }")) – Position in the rulebase. Can be specified in various ways.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(layer='', name='', uid='', params={})[source]

Deletes an existing access section within a layer.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-access-section

Parameters:
  • layer – Layer that the section belongs to identified by name or UID.
  • name – (optional) The name of an existing access section.
  • uid – (optional) The unique identifier of an existing access section.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(layer='', name='', uid='', params={})[source]

Sets new values for an access section within a layer.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-access-section

Parameters:
  • layer – Layer that the section belongs to identified by name or UID.
  • name – (optional) The name of an existing access section.
  • uid – (optional) The unique identifier of an existing access section.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(layer='', name='', uid='', params={})[source]

Shows details of an access section within a layer.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-access-section

Parameters:
  • layer – Layer that the section belongs to identified by name or UID.
  • name – (optional) The name of an existing access section.
  • uid – (optional) The unique identifier of an existing access section.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
class cpauto.objects.access.NATRule(core_client)[source]

Manage NAT rules.

add(package='', position='', params={})[source]

Adds a NAT rule.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-nat-rule

Parameters:
  • package – Package that the rule belongs to identified by name.
  • position (integer, string or dict (e.g. 1, 'top', 'bottom', or "{ 'above': 'Section One' }")) – Position in the rulebase. Can be specified in various ways.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(package='', uid='', params={})[source]

Deletes a NAT rule within a package.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-nat-rule

Parameters:
  • package – Package that the rule belongs to identified by name.
  • uid – (optional) The unique identifier of an existing access rule.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
set(package='', uid='', params={})[source]

Sets new values for a NAT rule within a package.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-nat-rule

Parameters:
  • package – Package that the rule belongs to identified by name.
  • uid – (optional) The unique identifier of an existing access rule.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(package='', uid='', params={})[source]

Shows details of a NAT rule within a package.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-nat-rule

Parameters:
  • package – Package that the rule belongs to identified by name.
  • uid – (optional) The unique identifier of an existing access rule.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show_all(package='', params={})[source]

Show all NAT rules within a package.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-nat-rulebase

Parameters:
  • package – The name of an existing package.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
class cpauto.objects.access.NATSection(core_client)[source]

Manage NAT sections.

add(package='', position='', params={})[source]

Adds a NAT section.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-nat-section

Parameters:
  • package – Package that the section belongs to identified by name.
  • position (integer, string or dict (e.g. 1, 'top', 'bottom', or "{ 'above': 'Section One' }")) – Position in the rulebase. Can be specified in various ways.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
delete(package='', name='', uid='', params={})[source]

Deletes a NAT section within a package.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-nat-section

Parameters:
  • package – Package that the section belongs to identified by name.
  • name – (optional) The name of an existing NAT section.
  • uid – (optional) The unique identifier of an existing NAT section.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
set(package='', name='', uid='', params={})[source]

Sets new values for a NAT section within a package.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-nat-section

Parameters:
  • package – Package that the section belongs to identified by name.
  • name – (optional) The name of an existing NAT section.
  • uid – (optional) The unique identifier of an existing NAT section.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(package='', name='', uid='', params={})[source]

Shows details of a NAT section within a package.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-nat-section

Parameters:
  • package – Package that the section belongs to identified by name.
  • name – (optional) The name of an existing NAT section.
  • uid – (optional) The unique identifier of an existing NAT section.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult

cpauto.objects.application module

This module contains the classes needed to manage application objects.

class cpauto.objects.application.App(core_client)[source]

Manage application sites.

add(name='', url_list='', app_sig='', params={})[source]

Adds an application site.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-application-site

Parameters:
  • name – A name for the new application site.
  • url_list (string or list of strings) – (optional) A URL or set of URLs that comprises the application.
  • app_sig (string or list of strings) – (optional) A signature or set of signatures generated via the signature tool.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing application site with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-application-site

Parameters:
  • name – (optional) The name of an existing application site.
  • uid – (optional) The unique identifier of an existing application site.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing application site with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-application-site

Parameters:
  • name – (optional) The name of an existing application site.
  • uid – (optional) The unique identifier of an existing application site.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', app_id='', details_level='')[source]

Shows details of an application site with the specified name, uid, or application ID.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-application-site

Parameters:
  • name – (optional) The name of an existing application site.
  • uid – (optional) The unique identifier of an existing application site.
  • app_id – (optional) The application ID of an existing application site.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all application sites with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-application-sites

Parameters:
  • limit – (optional) Limit the total number of results shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of items in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
class cpauto.objects.application.AppCategory(core_client)[source]

Manage application site categories.

add(name='', params={})[source]

Adds an application site category.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-application-site-category

Parameters:
  • name – A name for the new application site category.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing application site category with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-application-site-category

Parameters:
  • name – (optional) The name of an existing application site category.
  • uid – (optional) The unique identifier of an existing application site category.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing application site category with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-application-site-category

Parameters:
  • name – (optional) The name of an existing application site category.
  • uid – (optional) The unique identifier of an existing application site category.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of an application site category with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-application-site-category

Parameters:
  • name – (optional) The name of an existing application site category.
  • uid – (optional) The unique identifier of an existing application site category.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all application site categories with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-application-site-categories

Parameters:
  • limit – (optional) Limit the total number of results shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of items in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
class cpauto.objects.application.AppGroup(core_client)[source]

Manage application site groups.

add(name='', params={})[source]

Adds an application site group.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-application-site-group

Parameters:
  • name – A name for the new application site group.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing application site group with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-application-site-group

Parameters:
  • name – (optional) The name of an existing application site group.
  • uid – (optional) The unique identifier of an existing application site group.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing application site group with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-application-site-group

Parameters:
  • name – (optional) The name of an existing application site group.
  • uid – (optional) The unique identifier of an existing application site group.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of an application site group with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-application-site-group

Parameters:
  • name – (optional) The name of an existing application site group.
  • uid – (optional) The unique identifier of an existing application site group.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all application site groups with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-application-site-groups

Parameters:
  • limit – (optional) Limit the total number of results shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of items in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult

cpauto.objects.group module

This module contains the classes needed to manage group objects.

class cpauto.objects.group.Group(core_client)[source]

Manage groups.

add(name='', params={})[source]

Adds a group.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-group

Parameters:
  • name – A name for the new group.
  • params – A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing group with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-group

Parameters:
  • name – (optional) The name of an existing group.
  • uid – (optional) The unique identifier of an existing group.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing group with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-group

Parameters:
  • name – (optional) The name of an existing group.
  • uid – (optional) The unique identifier of an existing group.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a group with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-group

Parameters:
  • name – (optional) The name of an existing group.
  • uid – (optional) The unique identifier of an existing group.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all groups with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-groups

Parameters:
  • limit – (optional) Limit the total number of groups shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of groups in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult

cpauto.objects.host module

This module contains the classes needed to manage host objects.

class cpauto.objects.host.Host(core_client)[source]

Manage hosts.

add(name='', ip_address='', ipv4_address='', ipv6_address='', params={})[source]

Adds a host.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-host

Parameters:
  • name – A name for the new host.
  • ip_address – (optional) IPv4 or IPv6 address. If both addresses are required use ipv4_address and ipv6_address fields explicitly.
  • ipv4_address – (optional) IPv4 address.
  • ipv6_address – (optional) IPv6 address.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing host with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-host

Parameters:
  • name – (optional) The name of an existing host.
  • uid – (optional) The unique identifier of an existing host.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing host with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-host

Parameters:
  • name – (optional) The name of an existing host.
  • uid – (optional) The unique identifier of an existing host.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a host with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-host

Parameters:
  • name – (optional) The name of an existing host.
  • uid – (optional) The unique identifier of an existing host.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all hosts with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-hosts

Parameters:
  • limit – (optional) Limit the total number of hosts shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of hosts in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult

cpauto.objects.network module

This module contains the classes needed to manage network objects.

class cpauto.objects.network.Network(core_client)[source]

Manage networks.

add(name='', params={})[source]

Adds a network.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-network

Parameters:
  • name – A name for the new network.
  • params – A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing network with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-network

Parameters:
  • name – (optional) The name of an existing network.
  • uid – (optional) The unique identifier of an existing network.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing network with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-network

Parameters:
  • name – (optional) The name of an existing network.
  • uid – (optional) The unique identifier of an existing network.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a network with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-network

Parameters:
  • name – (optional) The name of an existing network.
  • uid – (optional) The unique identifier of an existing network.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all networks with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-networks

Parameters:
  • limit – (optional) Limit the total number of networks shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of networks in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult

cpauto.objects.policy module

This module contains the classes needed to manage policy objects.

class cpauto.objects.policy.Policy(core_client)[source]

Manage policy.

install(access=True, threat=True, policy_package='', targets='')[source]

Installs the specified policy package or the standard policy package.

https://sc1.checkpoint.com/documents/R80/APIs/#web/install-policy

Parameters:
  • access – (optional) Install access policy. Default is true.
  • threat – (optional) Install threat prevention policy. Default is true.
  • policy_package (string) – (optional) Install specific policy package. Default is standard.
  • targets (string or list of strings) – (optional) Policy install targets.
Return type:

CoreClientResult
class cpauto.objects.policy.PolicyPackage(core_client)[source]

Manage policy packages.

add(name='', params={})[source]

Adds a new policy package.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-package

Parameters:
  • name – The name of the new policy package.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing policy package with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-package

Parameters:
  • name – (optional) The name of an existing policy package.
  • uid – (optional) The unique identifier of an existing policy package.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing policy package with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-package

Parameters:
  • name – (optional) The name of an existing policy package.
  • uid – (optional) The unique identifier of an existing policy package.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a policy package with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-package

Parameters:
  • name – (optional) The name of an existing policy package.
  • uid – (optional) The unique identifier of an existing policy package.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all policy packages with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-packages

Parameters:
  • limit – (optional) Limit the total number of networks shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of networks in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult

cpauto.objects.service module

This module contains the classes needed to manage service objects.

class cpauto.objects.service.ServiceDCERPC(core_client)[source]

Manage DCE-RPC services.

add(name='', params={})[source]

Adds a DCE-RPC service.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-service-dce-rpc

Parameters:
  • name – A name for the new DCE-RPC service.
  • params – A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing DCE-RPC service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-service-dce-rpc

Parameters:
  • name – (optional) The name of an existing DCE-RPC service.
  • uid – (optional) The unique identifier of an existing DCE-RPC service.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing DCE-RPC service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-service-dce-rpc

Parameters:
  • name – (optional) The name of an existing DCE-RPC service.
  • uid – (optional) The unique identifier of an existing DCE-RPC service.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a DCE-RPC service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-service-dce-rpc

Parameters:
  • name – (optional) The name of an existing DCE-RPC service.
  • uid – (optional) The unique identifier of an existing DCE-RPC service.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all DCE-RPC services with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-services-dce-rpc

Parameters:
  • limit – (optional) Limit the total number of DCE-RPC services shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of DCE-RPC services in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
class cpauto.objects.service.ServiceGroup(core_client)[source]

Manage service groups.

add(name='', params={})[source]

Adds a service group.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-service-group

Parameters:
  • name – A name for the new service group.
  • params – A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing service group with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-service-group

Parameters:
  • name – (optional) The name of an existing service group.
  • uid – (optional) The unique identifier of an existing service group.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing service group with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-service-group

Parameters:
  • name – (optional) The name of an existing service group.
  • uid – (optional) The unique identifier of an existing service group.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a service group with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-service-group

Parameters:
  • name – (optional) The name of an existing service group.
  • uid – (optional) The unique identifier of an existing service group.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all service groups with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-service-groups

Parameters:
  • limit – (optional) Limit the total number of service groups shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of service groups in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
class cpauto.objects.service.ServiceOther(core_client)[source]

Manage generic services.

add(name='', params={})[source]

Adds a generic service.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-service-other

Parameters:
  • name – A name for the new generic service.
  • params – A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing generic service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-service-other

Parameters:
  • name – (optional) The name of an existing generic service.
  • uid – (optional) The unique identifier of an existing generic service.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing generic service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-service-other

Parameters:
  • name – (optional) The name of an existing generic service.
  • uid – (optional) The unique identifier of an existing generic service.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a generic service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-service-other

Parameters:
  • name – (optional) The name of an existing generic service.
  • uid – (optional) The unique identifier of an existing generic service.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all generic services with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-services-other

Parameters:
  • limit – (optional) Limit the total number of generic services shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of generic services in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
class cpauto.objects.service.ServiceRPC(core_client)[source]

Manage RPC services.

add(name='', params={})[source]

Adds a RPC service.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-service-rpc

Parameters:
  • name – A name for the new RPC service.
  • params – A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing RPC service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-service-rpc

Parameters:
  • name – (optional) The name of an existing RPC service.
  • uid – (optional) The unique identifier of an existing RPC service.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing RPC service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-service-rpc

Parameters:
  • name – (optional) The name of an existing RPC service.
  • uid – (optional) The unique identifier of an existing RPC service.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a RPC service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-service-rpc

Parameters:
  • name – (optional) The name of an existing RPC service.
  • uid – (optional) The unique identifier of an existing RPC service.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all RPC services with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-services-rpc

Parameters:
  • limit – (optional) Limit the total number of RPC services shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of RPC services in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
class cpauto.objects.service.ServiceSCTP(core_client)[source]

Manage SCTP services.

add(name='', port='', params={})[source]

Adds a SCTP service.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-service-sctp

Parameters:
  • name – A name for the new SCTP service.
  • port – Port number or range (e.g. “443” or “80-81”).
  • params – A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing SCTP service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-service-sctp

Parameters:
  • name – (optional) The name of an existing SCTP service.
  • uid – (optional) The unique identifier of an existing SCTP service.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing SCTP service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-service-sctp

Parameters:
  • name – (optional) The name of an existing SCTP service.
  • uid – (optional) The unique identifier of an existing SCTP service.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a SCTP service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-service-sctp

Parameters:
  • name – (optional) The name of an existing SCTP service.
  • uid – (optional) The unique identifier of an existing SCTP service.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all SCTP services with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-services-sctp

Parameters:
  • limit – (optional) Limit the total number of SCTP services shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of SCTP services in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
class cpauto.objects.service.ServiceTCP(core_client)[source]

Manage TCP services.

add(name='', params={})[source]

Adds a TCP service.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-service-tcp

Parameters:
  • name – A name for the new TCP service.
  • params – A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing TCP service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-service-tcp

Parameters:
  • name – (optional) The name of an existing TCP service.
  • uid – (optional) The unique identifier of an existing TCP service.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing TCP service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-service-tcp

Parameters:
  • name – (optional) The name of an existing TCP service.
  • uid – (optional) The unique identifier of an existing TCP service.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a TCP service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-service-tcp

Parameters:
  • name – (optional) The name of an existing TCP service.
  • uid – (optional) The unique identifier of an existing TCP service.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all TCP services with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-services-tcp

Parameters:
  • limit – (optional) Limit the total number of TCP services shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of TCP services in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
class cpauto.objects.service.ServiceUDP(core_client)[source]

Manage UDP services.

add(name='', params={})[source]

Adds a UDP service.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-service-udp

Parameters:
  • name – A name for the new UDP service.
  • params – A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes an existing UDP service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-service-udp

Parameters:
  • name – (optional) The name of an existing UDP service.
  • uid – (optional) The unique identifier of an existing UDP service.
  • params – (optional) A dictionary of additional, supported parameter name$
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing UDP service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-service-udp

Parameters:
  • name – (optional) The name of an existing UDP service.
  • uid – (optional) The unique identifier of an existing UDP service.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a UDP service with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-service-udp

Parameters:
  • name – (optional) The name of an existing UDP service.
  • uid – (optional) The unique identifier of an existing UDP service.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all UDP services with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-services-udp

Parameters:
  • limit – (optional) Limit the total number of UDP services shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of UDP services in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult

cpauto.objects.simplegateway module

This module contains the classes needed to manage simple gateway objects.

class cpauto.objects.simplegateway.SimpleGateway(core_client)[source]

Manage simple gateways.

add(name='', ip_address='', ipv4_address='', ipv6_address='', params={})[source]

Adds a simple gateway.

https://sc1.checkpoint.com/documents/R80/APIs/#web/add-simple-gateway

Parameters:
  • name – A name for the new simple gateway.
  • ip_address – (optional) IPv4 or IPv6 address. If both addresses are required use ipv4_address and ipv6_address fields explicitly.
  • ipv4_address – (optional) IPv4 address.
  • ipv6_address – (optional) IPv6 address.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
delete(name='', uid='', params={})[source]

Deletes a simple gateway.

https://sc1.checkpoint.com/documents/R80/APIs/#web/delete-simple-gateway

Parameters:
  • name – (optional) A simple gateway name.
  • uid – (optional) A simple gateway unique identifier instead of name.
Return type:

CoreClientResult
set(name='', uid='', params={})[source]

Sets new values for an existing simple gateway with the specified name or uid.

https://sc1.checkpoint.com/documents/R80/APIs/#web/set-simple-gateway

Parameters:
  • name – (optional) The name of an existing simple gateway.
  • uid – (optional) The unique identifier of an existing simple gateway.
  • params – (optional) A dictionary of additional, supported parameter names and values.
Return type:

CoreClientResult
show(name='', uid='', details_level='')[source]

Shows details of a simple gateway with the specified name or unique identifier.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-simple-gateway

Parameters:
  • name – (optional) A simple gateway name.
  • uid – (optional) A simple gateway unique identifier instead of name.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult
show_all(limit=50, offset=0, order=[], details_level='')[source]

Shows all simple gateways with some reasonable limitations.

https://sc1.checkpoint.com/documents/R80/APIs/#web/show-simple-gateways

Parameters:
  • limit – (optional) Limit the total number of simple gateways shown. The default value is 50 and allowed values are in the range 1 to 500.
  • offset – (optional) Skip a number of simple gateways in the results before they are shown. Default value is 0.
  • order – (optional) Sort the results by the specified field. The default is a random order.
  • details_level – (optional) The level of detail to show. Default value is ‘standard’ and the other options are: ‘uid’ or ‘full’
Return type:

CoreClientResult

Module contents