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

checkpoint.ManagementRestoreDomain

Explore with Pulumi AI

Create ManagementRestoreDomain Resource

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

Constructor syntax

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

@overload
def ManagementRestoreDomain(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            domain_ip_address: Optional[str] = None,
                            domain_name: Optional[str] = None,
                            domain_server_name: Optional[str] = None,
                            file_path: Optional[str] = None,
                            management_restore_domain_id: Optional[str] = None,
                            verify_only: Optional[bool] = None)
func NewManagementRestoreDomain(ctx *Context, name string, args ManagementRestoreDomainArgs, opts ...ResourceOption) (*ManagementRestoreDomain, error)
public ManagementRestoreDomain(string name, ManagementRestoreDomainArgs args, CustomResourceOptions? opts = null)
public ManagementRestoreDomain(String name, ManagementRestoreDomainArgs args)
public ManagementRestoreDomain(String name, ManagementRestoreDomainArgs args, CustomResourceOptions options)
type: checkpoint:ManagementRestoreDomain
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 This property is required. ManagementRestoreDomainArgs
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 This property is required. ManagementRestoreDomainArgs
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 This property is required. ManagementRestoreDomainArgs
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 This property is required. ManagementRestoreDomainArgs
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. ManagementRestoreDomainArgs
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 managementRestoreDomainResource = new Checkpoint.ManagementRestoreDomain("managementRestoreDomainResource", new()
{
    DomainIpAddress = "string",
    DomainName = "string",
    DomainServerName = "string",
    FilePath = "string",
    ManagementRestoreDomainId = "string",
    VerifyOnly = false,
});
Copy
example, err := checkpoint.NewManagementRestoreDomain(ctx, "managementRestoreDomainResource", &checkpoint.ManagementRestoreDomainArgs{
DomainIpAddress: pulumi.String("string"),
DomainName: pulumi.String("string"),
DomainServerName: pulumi.String("string"),
FilePath: pulumi.String("string"),
ManagementRestoreDomainId: pulumi.String("string"),
VerifyOnly: pulumi.Bool(false),
})
Copy
var managementRestoreDomainResource = new ManagementRestoreDomain("managementRestoreDomainResource", ManagementRestoreDomainArgs.builder()
    .domainIpAddress("string")
    .domainName("string")
    .domainServerName("string")
    .filePath("string")
    .managementRestoreDomainId("string")
    .verifyOnly(false)
    .build());
Copy
management_restore_domain_resource = checkpoint.ManagementRestoreDomain("managementRestoreDomainResource",
    domain_ip_address="string",
    domain_name="string",
    domain_server_name="string",
    file_path="string",
    management_restore_domain_id="string",
    verify_only=False)
Copy
const managementRestoreDomainResource = new checkpoint.ManagementRestoreDomain("managementRestoreDomainResource", {
    domainIpAddress: "string",
    domainName: "string",
    domainServerName: "string",
    filePath: "string",
    managementRestoreDomainId: "string",
    verifyOnly: false,
});
Copy
type: checkpoint:ManagementRestoreDomain
properties:
    domainIpAddress: string
    domainName: string
    domainServerName: string
    filePath: string
    managementRestoreDomainId: string
    verifyOnly: false
Copy

ManagementRestoreDomain 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 ManagementRestoreDomain resource accepts the following input properties:

DomainIpAddress This property is required. string
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
DomainName This property is required. string
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
DomainServerName This property is required. string
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
FilePath This property is required. string
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
ManagementRestoreDomainId string
VerifyOnly bool
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
DomainIpAddress This property is required. string
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
DomainName This property is required. string
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
DomainServerName This property is required. string
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
FilePath This property is required. string
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
ManagementRestoreDomainId string
VerifyOnly bool
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
domainIpAddress This property is required. String
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
domainName This property is required. String
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
domainServerName This property is required. String
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
filePath This property is required. String
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
managementRestoreDomainId String
verifyOnly Boolean
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
domainIpAddress This property is required. string
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
domainName This property is required. string
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
domainServerName This property is required. string
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
filePath This property is required. string
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
managementRestoreDomainId string
verifyOnly boolean
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
domain_ip_address This property is required. str
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
domain_name This property is required. str
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
domain_server_name This property is required. str
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
file_path This property is required. str
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
management_restore_domain_id str
verify_only bool
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
domainIpAddress This property is required. String
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
domainName This property is required. String
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
domainServerName This property is required. String
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
filePath This property is required. String
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
managementRestoreDomainId String
verifyOnly Boolean
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.

Outputs

All input properties are implicitly available as output properties. Additionally, the ManagementRestoreDomain 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 ManagementRestoreDomain Resource

Get an existing ManagementRestoreDomain 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?: ManagementRestoreDomainState, opts?: CustomResourceOptions): ManagementRestoreDomain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain_ip_address: Optional[str] = None,
        domain_name: Optional[str] = None,
        domain_server_name: Optional[str] = None,
        file_path: Optional[str] = None,
        management_restore_domain_id: Optional[str] = None,
        task_id: Optional[str] = None,
        verify_only: Optional[bool] = None) -> ManagementRestoreDomain
func GetManagementRestoreDomain(ctx *Context, name string, id IDInput, state *ManagementRestoreDomainState, opts ...ResourceOption) (*ManagementRestoreDomain, error)
public static ManagementRestoreDomain Get(string name, Input<string> id, ManagementRestoreDomainState? state, CustomResourceOptions? opts = null)
public static ManagementRestoreDomain get(String name, Output<String> id, ManagementRestoreDomainState state, CustomResourceOptions options)
resources:  _:    type: checkpoint:ManagementRestoreDomain    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:
DomainIpAddress string
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
DomainName string
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
DomainServerName string
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
FilePath string
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
ManagementRestoreDomainId string
TaskId string
Asynchronous task unique identifier.
VerifyOnly bool
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
DomainIpAddress string
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
DomainName string
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
DomainServerName string
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
FilePath string
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
ManagementRestoreDomainId string
TaskId string
Asynchronous task unique identifier.
VerifyOnly bool
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
domainIpAddress String
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
domainName String
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
domainServerName String
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
filePath String
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
managementRestoreDomainId String
taskId String
Asynchronous task unique identifier.
verifyOnly Boolean
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
domainIpAddress string
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
domainName string
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
domainServerName string
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
filePath string
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
managementRestoreDomainId string
taskId string
Asynchronous task unique identifier.
verifyOnly boolean
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
domain_ip_address str
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
domain_name str
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
domain_server_name str
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
file_path str
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
management_restore_domain_id str
task_id str
Asynchronous task unique identifier.
verify_only bool
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.
domainIpAddress String
IPv4 address.Required only for importing Security Management Server into Multi-Domain Server.
domainName String
Domain name. Should be unique in the MDS.Required only for importing Security Management Server into Multi-Domain Server.
domainServerName String
Multi Domain server name.Required only for importing Security Management Server into Multi-Domain Server.
filePath String
Path to the backup file to be restored. Should be the full file path (example, "/var/log/domain1_backup.tgz").
managementRestoreDomainId String
taskId String
Asynchronous task unique identifier.
verifyOnly Boolean
If true, verify that the import operation is valid for this input file and this environment Note: Restore operation will not be executed.

Package Details

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