1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. ManagementCommandExportManagement
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw

checkpoint.ManagementCommandExportManagement

Explore with Pulumi AI

Create ManagementCommandExportManagement Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ManagementCommandExportManagement(name: string, args?: ManagementCommandExportManagementArgs, opts?: CustomResourceOptions);
@overload
def ManagementCommandExportManagement(resource_name: str,
                                      args: Optional[ManagementCommandExportManagementArgs] = None,
                                      opts: Optional[ResourceOptions] = None)

@overload
def ManagementCommandExportManagement(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      domain_name: Optional[str] = None,
                                      file_path: Optional[str] = None,
                                      ignore_warnings: Optional[bool] = None,
                                      include_endpoint_configuration: Optional[bool] = None,
                                      include_endpoint_database: Optional[bool] = None,
                                      include_logs: Optional[bool] = None,
                                      include_logs_indexes: Optional[bool] = None,
                                      is_domain_backup: Optional[bool] = None,
                                      is_smc_to_mds: Optional[bool] = None,
                                      management_command_export_management_id: Optional[str] = None,
                                      pre_export_verification_only: Optional[bool] = None,
                                      version: Optional[str] = None)
func NewManagementCommandExportManagement(ctx *Context, name string, args *ManagementCommandExportManagementArgs, opts ...ResourceOption) (*ManagementCommandExportManagement, error)
public ManagementCommandExportManagement(string name, ManagementCommandExportManagementArgs? args = null, CustomResourceOptions? opts = null)
public ManagementCommandExportManagement(String name, ManagementCommandExportManagementArgs args)
public ManagementCommandExportManagement(String name, ManagementCommandExportManagementArgs args, CustomResourceOptions options)
type: checkpoint:ManagementCommandExportManagement
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ManagementCommandExportManagementArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ManagementCommandExportManagementArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ManagementCommandExportManagementArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ManagementCommandExportManagementArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ManagementCommandExportManagementArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var managementCommandExportManagementResource = new Checkpoint.ManagementCommandExportManagement("managementCommandExportManagementResource", new()
{
    DomainName = "string",
    FilePath = "string",
    IgnoreWarnings = false,
    IncludeEndpointConfiguration = false,
    IncludeEndpointDatabase = false,
    IncludeLogs = false,
    IncludeLogsIndexes = false,
    IsDomainBackup = false,
    IsSmcToMds = false,
    ManagementCommandExportManagementId = "string",
    PreExportVerificationOnly = false,
    Version = "string",
});
Copy
example, err := checkpoint.NewManagementCommandExportManagement(ctx, "managementCommandExportManagementResource", &checkpoint.ManagementCommandExportManagementArgs{
	DomainName:                          pulumi.String("string"),
	FilePath:                            pulumi.String("string"),
	IgnoreWarnings:                      pulumi.Bool(false),
	IncludeEndpointConfiguration:        pulumi.Bool(false),
	IncludeEndpointDatabase:             pulumi.Bool(false),
	IncludeLogs:                         pulumi.Bool(false),
	IncludeLogsIndexes:                  pulumi.Bool(false),
	IsDomainBackup:                      pulumi.Bool(false),
	IsSmcToMds:                          pulumi.Bool(false),
	ManagementCommandExportManagementId: pulumi.String("string"),
	PreExportVerificationOnly:           pulumi.Bool(false),
	Version:                             pulumi.String("string"),
})
Copy
var managementCommandExportManagementResource = new ManagementCommandExportManagement("managementCommandExportManagementResource", ManagementCommandExportManagementArgs.builder()
    .domainName("string")
    .filePath("string")
    .ignoreWarnings(false)
    .includeEndpointConfiguration(false)
    .includeEndpointDatabase(false)
    .includeLogs(false)
    .includeLogsIndexes(false)
    .isDomainBackup(false)
    .isSmcToMds(false)
    .managementCommandExportManagementId("string")
    .preExportVerificationOnly(false)
    .version("string")
    .build());
Copy
management_command_export_management_resource = checkpoint.ManagementCommandExportManagement("managementCommandExportManagementResource",
    domain_name="string",
    file_path="string",
    ignore_warnings=False,
    include_endpoint_configuration=False,
    include_endpoint_database=False,
    include_logs=False,
    include_logs_indexes=False,
    is_domain_backup=False,
    is_smc_to_mds=False,
    management_command_export_management_id="string",
    pre_export_verification_only=False,
    version="string")
Copy
const managementCommandExportManagementResource = new checkpoint.ManagementCommandExportManagement("managementCommandExportManagementResource", {
    domainName: "string",
    filePath: "string",
    ignoreWarnings: false,
    includeEndpointConfiguration: false,
    includeEndpointDatabase: false,
    includeLogs: false,
    includeLogsIndexes: false,
    isDomainBackup: false,
    isSmcToMds: false,
    managementCommandExportManagementId: "string",
    preExportVerificationOnly: false,
    version: "string",
});
Copy
type: checkpoint:ManagementCommandExportManagement
properties:
    domainName: string
    filePath: string
    ignoreWarnings: false
    includeEndpointConfiguration: false
    includeEndpointDatabase: false
    includeLogs: false
    includeLogsIndexes: false
    isDomainBackup: false
    isSmcToMds: false
    managementCommandExportManagementId: string
    preExportVerificationOnly: false
    version: string
Copy

ManagementCommandExportManagement Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ManagementCommandExportManagement resource accepts the following input properties:

DomainName string
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
FilePath string
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
IgnoreWarnings bool
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
IncludeEndpointConfiguration bool
Include export of the Endpoint Security Management configuration files.
IncludeEndpointDatabase bool
Include export of the Endpoint Security Management database.
IncludeLogs bool
Export logs without log indexes.
IncludeLogsIndexes bool
Export logs with log indexes.
IsDomainBackup bool
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
IsSmcToMds bool
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
ManagementCommandExportManagementId string
PreExportVerificationOnly bool
If true, only runs the pre-export verifications instead of the full export.
Version string
Target version.
DomainName string
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
FilePath string
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
IgnoreWarnings bool
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
IncludeEndpointConfiguration bool
Include export of the Endpoint Security Management configuration files.
IncludeEndpointDatabase bool
Include export of the Endpoint Security Management database.
IncludeLogs bool
Export logs without log indexes.
IncludeLogsIndexes bool
Export logs with log indexes.
IsDomainBackup bool
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
IsSmcToMds bool
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
ManagementCommandExportManagementId string
PreExportVerificationOnly bool
If true, only runs the pre-export verifications instead of the full export.
Version string
Target version.
domainName String
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
filePath String
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
ignoreWarnings Boolean
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
includeEndpointConfiguration Boolean
Include export of the Endpoint Security Management configuration files.
includeEndpointDatabase Boolean
Include export of the Endpoint Security Management database.
includeLogs Boolean
Export logs without log indexes.
includeLogsIndexes Boolean
Export logs with log indexes.
isDomainBackup Boolean
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
isSmcToMds Boolean
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
managementCommandExportManagementId String
preExportVerificationOnly Boolean
If true, only runs the pre-export verifications instead of the full export.
version String
Target version.
domainName string
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
filePath string
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
ignoreWarnings boolean
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
includeEndpointConfiguration boolean
Include export of the Endpoint Security Management configuration files.
includeEndpointDatabase boolean
Include export of the Endpoint Security Management database.
includeLogs boolean
Export logs without log indexes.
includeLogsIndexes boolean
Export logs with log indexes.
isDomainBackup boolean
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
isSmcToMds boolean
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
managementCommandExportManagementId string
preExportVerificationOnly boolean
If true, only runs the pre-export verifications instead of the full export.
version string
Target version.
domain_name str
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
file_path str
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
ignore_warnings bool
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
include_endpoint_configuration bool
Include export of the Endpoint Security Management configuration files.
include_endpoint_database bool
Include export of the Endpoint Security Management database.
include_logs bool
Export logs without log indexes.
include_logs_indexes bool
Export logs with log indexes.
is_domain_backup bool
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
is_smc_to_mds bool
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
management_command_export_management_id str
pre_export_verification_only bool
If true, only runs the pre-export verifications instead of the full export.
version str
Target version.
domainName String
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
filePath String
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
ignoreWarnings Boolean
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
includeEndpointConfiguration Boolean
Include export of the Endpoint Security Management configuration files.
includeEndpointDatabase Boolean
Include export of the Endpoint Security Management database.
includeLogs Boolean
Export logs without log indexes.
includeLogsIndexes Boolean
Export logs with log indexes.
isDomainBackup Boolean
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
isSmcToMds Boolean
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
managementCommandExportManagementId String
preExportVerificationOnly Boolean
If true, only runs the pre-export verifications instead of the full export.
version String
Target version.

Outputs

All input properties are implicitly available as output properties. Additionally, the ManagementCommandExportManagement resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
TaskId string
Asynchronous task unique identifier.
Id string
The provider-assigned unique ID for this managed resource.
TaskId string
Asynchronous task unique identifier.
id String
The provider-assigned unique ID for this managed resource.
taskId String
Asynchronous task unique identifier.
id string
The provider-assigned unique ID for this managed resource.
taskId string
Asynchronous task unique identifier.
id str
The provider-assigned unique ID for this managed resource.
task_id str
Asynchronous task unique identifier.
id String
The provider-assigned unique ID for this managed resource.
taskId String
Asynchronous task unique identifier.

Look up Existing ManagementCommandExportManagement Resource

Get an existing ManagementCommandExportManagement resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ManagementCommandExportManagementState, opts?: CustomResourceOptions): ManagementCommandExportManagement
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain_name: Optional[str] = None,
        file_path: Optional[str] = None,
        ignore_warnings: Optional[bool] = None,
        include_endpoint_configuration: Optional[bool] = None,
        include_endpoint_database: Optional[bool] = None,
        include_logs: Optional[bool] = None,
        include_logs_indexes: Optional[bool] = None,
        is_domain_backup: Optional[bool] = None,
        is_smc_to_mds: Optional[bool] = None,
        management_command_export_management_id: Optional[str] = None,
        pre_export_verification_only: Optional[bool] = None,
        task_id: Optional[str] = None,
        version: Optional[str] = None) -> ManagementCommandExportManagement
func GetManagementCommandExportManagement(ctx *Context, name string, id IDInput, state *ManagementCommandExportManagementState, opts ...ResourceOption) (*ManagementCommandExportManagement, error)
public static ManagementCommandExportManagement Get(string name, Input<string> id, ManagementCommandExportManagementState? state, CustomResourceOptions? opts = null)
public static ManagementCommandExportManagement get(String name, Output<String> id, ManagementCommandExportManagementState state, CustomResourceOptions options)
resources:  _:    type: checkpoint:ManagementCommandExportManagement    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DomainName string
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
FilePath string
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
IgnoreWarnings bool
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
IncludeEndpointConfiguration bool
Include export of the Endpoint Security Management configuration files.
IncludeEndpointDatabase bool
Include export of the Endpoint Security Management database.
IncludeLogs bool
Export logs without log indexes.
IncludeLogsIndexes bool
Export logs with log indexes.
IsDomainBackup bool
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
IsSmcToMds bool
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
ManagementCommandExportManagementId string
PreExportVerificationOnly bool
If true, only runs the pre-export verifications instead of the full export.
TaskId string
Asynchronous task unique identifier.
Version string
Target version.
DomainName string
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
FilePath string
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
IgnoreWarnings bool
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
IncludeEndpointConfiguration bool
Include export of the Endpoint Security Management configuration files.
IncludeEndpointDatabase bool
Include export of the Endpoint Security Management database.
IncludeLogs bool
Export logs without log indexes.
IncludeLogsIndexes bool
Export logs with log indexes.
IsDomainBackup bool
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
IsSmcToMds bool
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
ManagementCommandExportManagementId string
PreExportVerificationOnly bool
If true, only runs the pre-export verifications instead of the full export.
TaskId string
Asynchronous task unique identifier.
Version string
Target version.
domainName String
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
filePath String
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
ignoreWarnings Boolean
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
includeEndpointConfiguration Boolean
Include export of the Endpoint Security Management configuration files.
includeEndpointDatabase Boolean
Include export of the Endpoint Security Management database.
includeLogs Boolean
Export logs without log indexes.
includeLogsIndexes Boolean
Export logs with log indexes.
isDomainBackup Boolean
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
isSmcToMds Boolean
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
managementCommandExportManagementId String
preExportVerificationOnly Boolean
If true, only runs the pre-export verifications instead of the full export.
taskId String
Asynchronous task unique identifier.
version String
Target version.
domainName string
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
filePath string
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
ignoreWarnings boolean
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
includeEndpointConfiguration boolean
Include export of the Endpoint Security Management configuration files.
includeEndpointDatabase boolean
Include export of the Endpoint Security Management database.
includeLogs boolean
Export logs without log indexes.
includeLogsIndexes boolean
Export logs with log indexes.
isDomainBackup boolean
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
isSmcToMds boolean
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
managementCommandExportManagementId string
preExportVerificationOnly boolean
If true, only runs the pre-export verifications instead of the full export.
taskId string
Asynchronous task unique identifier.
version string
Target version.
domain_name str
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
file_path str
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
ignore_warnings bool
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
include_endpoint_configuration bool
Include export of the Endpoint Security Management configuration files.
include_endpoint_database bool
Include export of the Endpoint Security Management database.
include_logs bool
Export logs without log indexes.
include_logs_indexes bool
Export logs with log indexes.
is_domain_backup bool
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
is_smc_to_mds bool
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
management_command_export_management_id str
pre_export_verification_only bool
If true, only runs the pre-export verifications instead of the full export.
task_id str
Asynchronous task unique identifier.
version str
Target version.
domainName String
Domain name to be exported.Required only for exporting a Domain from the Multi-Domain Server or backing up Domain.
filePath String
Path in which the exported database file is saved.Required only when not using pre-export-verification-only flag.
ignoreWarnings Boolean
Ignoring the verification warnings. By Setting this parameter to 'true' export will not be blocked by warnings.
includeEndpointConfiguration Boolean
Include export of the Endpoint Security Management configuration files.
includeEndpointDatabase Boolean
Include export of the Endpoint Security Management database.
includeLogs Boolean
Export logs without log indexes.
includeLogsIndexes Boolean
Export logs with log indexes.
isDomainBackup Boolean
If true, the exported Domain will be suitable for import on the same Multi-Domain Server only.
isSmcToMds Boolean
If true, the exported Security Management Server will be suitable for import on the Multi-Domain Server only.
managementCommandExportManagementId String
preExportVerificationOnly Boolean
If true, only runs the pre-export verifications instead of the full export.
taskId String
Asynchronous task unique identifier.
version String
Target version.

Package Details

Repository
checkpoint checkpointsw/terraform-provider-checkpoint
License
Notes
This Pulumi package is based on the checkpoint Terraform Provider.