Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Checkpoint Provider
  3. API Docs
  4. ManagementInstallPolicy
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpointsw/terraform-provider-checkpoint

checkpoint.ManagementInstallPolicy

Explore with Pulumi AI

checkpoint logo
checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
checkpointsw/terraform-provider-checkpoint

    Create ManagementInstallPolicy Resource

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

    Constructor syntax

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

@overload
def ManagementInstallPolicy(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            policy_package: Optional[str] = None,
                            targets: Optional[Sequence[str]] = None,
                            access: Optional[bool] = None,
                            desktop_security: Optional[bool] = None,
                            install_on_all_cluster_members_or_fail: Optional[bool] = None,
                            management_install_policy_id: Optional[str] = None,
                            prepare_only: Optional[bool] = None,
                            qos: Optional[bool] = None,
                            revision: Optional[str] = None,
                            threat_prevention: Optional[bool] = None,
                            triggers: Optional[Sequence[str]] = None)
    func NewManagementInstallPolicy(ctx *Context, name string, args ManagementInstallPolicyArgs, opts ...ResourceOption) (*ManagementInstallPolicy, error)
    public ManagementInstallPolicy(string name, ManagementInstallPolicyArgs args, CustomResourceOptions? opts = null)
    public ManagementInstallPolicy(String name, ManagementInstallPolicyArgs args)
public ManagementInstallPolicy(String name, ManagementInstallPolicyArgs args, CustomResourceOptions options)

    type: checkpoint:ManagementInstallPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ManagementInstallPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ManagementInstallPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ManagementInstallPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementInstallPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementInstallPolicyArgs
    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 managementInstallPolicyResource = new Checkpoint.ManagementInstallPolicy("managementInstallPolicyResource", new()
{
    PolicyPackage = "string",
    Targets = new[]
    {
        "string",
    },
    Access = false,
    DesktopSecurity = false,
    InstallOnAllClusterMembersOrFail = false,
    ManagementInstallPolicyId = "string",
    PrepareOnly = false,
    Qos = false,
    Revision = "string",
    ThreatPrevention = false,
    Triggers = new[]
    {
        "string",
    },
});

    example, err := checkpoint.NewManagementInstallPolicy(ctx, "managementInstallPolicyResource", &checkpoint.ManagementInstallPolicyArgs{
	PolicyPackage: pulumi.String("string"),
	Targets: pulumi.StringArray{
		pulumi.String("string"),
	},
	Access:                           pulumi.Bool(false),
	DesktopSecurity:                  pulumi.Bool(false),
	InstallOnAllClusterMembersOrFail: pulumi.Bool(false),
	ManagementInstallPolicyId:        pulumi.String("string"),
	PrepareOnly:                      pulumi.Bool(false),
	Qos:                              pulumi.Bool(false),
	Revision:                         pulumi.String("string"),
	ThreatPrevention:                 pulumi.Bool(false),
	Triggers: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var managementInstallPolicyResource = new ManagementInstallPolicy("managementInstallPolicyResource", ManagementInstallPolicyArgs.builder()
    .policyPackage("string")
    .targets("string")
    .access(false)
    .desktopSecurity(false)
    .installOnAllClusterMembersOrFail(false)
    .managementInstallPolicyId("string")
    .prepareOnly(false)
    .qos(false)
    .revision("string")
    .threatPrevention(false)
    .triggers("string")
    .build());

    management_install_policy_resource = checkpoint.ManagementInstallPolicy("managementInstallPolicyResource",
    policy_package="string",
    targets=["string"],
    access=False,
    desktop_security=False,
    install_on_all_cluster_members_or_fail=False,
    management_install_policy_id="string",
    prepare_only=False,
    qos=False,
    revision="string",
    threat_prevention=False,
    triggers=["string"])

    const managementInstallPolicyResource = new checkpoint.ManagementInstallPolicy("managementInstallPolicyResource", {
    policyPackage: "string",
    targets: ["string"],
    access: false,
    desktopSecurity: false,
    installOnAllClusterMembersOrFail: false,
    managementInstallPolicyId: "string",
    prepareOnly: false,
    qos: false,
    revision: "string",
    threatPrevention: false,
    triggers: ["string"],
});

    type: checkpoint:ManagementInstallPolicy
properties:
    access: false
    desktopSecurity: false
    installOnAllClusterMembersOrFail: false
    managementInstallPolicyId: string
    policyPackage: string
    prepareOnly: false
    qos: false
    revision: string
    targets:
        - string
    threatPrevention: false
    triggers:
        - string

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

    PolicyPackage string
    The name of the Policy Package to be installed.
    Targets List<string>
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    Access bool
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    DesktopSecurity bool
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    InstallOnAllClusterMembersOrFail bool
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    ManagementInstallPolicyId string
    PrepareOnly bool
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    Qos bool
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    Revision string
    The UID of the revision of the policy to install.
    ThreatPrevention bool
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    Triggers List<string>
    Triggers a install-policy if there are any changes to objects in this list.
    PolicyPackage string
    The name of the Policy Package to be installed.
    Targets []string
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    Access bool
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    DesktopSecurity bool
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    InstallOnAllClusterMembersOrFail bool
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    ManagementInstallPolicyId string
    PrepareOnly bool
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    Qos bool
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    Revision string
    The UID of the revision of the policy to install.
    ThreatPrevention bool
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    Triggers []string
    Triggers a install-policy if there are any changes to objects in this list.
    policyPackage String
    The name of the Policy Package to be installed.
    targets List<String>
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    access Boolean
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    desktopSecurity Boolean
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    installOnAllClusterMembersOrFail Boolean
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    managementInstallPolicyId String
    prepareOnly Boolean
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    qos Boolean
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    revision String
    The UID of the revision of the policy to install.
    threatPrevention Boolean
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    triggers List<String>
    Triggers a install-policy if there are any changes to objects in this list.
    policyPackage string
    The name of the Policy Package to be installed.
    targets string[]
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    access boolean
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    desktopSecurity boolean
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    installOnAllClusterMembersOrFail boolean
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    managementInstallPolicyId string
    prepareOnly boolean
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    qos boolean
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    revision string
    The UID of the revision of the policy to install.
    threatPrevention boolean
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    triggers string[]
    Triggers a install-policy if there are any changes to objects in this list.
    policy_package str
    The name of the Policy Package to be installed.
    targets Sequence[str]
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    access bool
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    desktop_security bool
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    install_on_all_cluster_members_or_fail bool
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    management_install_policy_id str
    prepare_only bool
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    qos bool
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    revision str
    The UID of the revision of the policy to install.
    threat_prevention bool
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    triggers Sequence[str]
    Triggers a install-policy if there are any changes to objects in this list.
    policyPackage String
    The name of the Policy Package to be installed.
    targets List<String>
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    access Boolean
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    desktopSecurity Boolean
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    installOnAllClusterMembersOrFail Boolean
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    managementInstallPolicyId String
    prepareOnly Boolean
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    qos Boolean
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    revision String
    The UID of the revision of the policy to install.
    threatPrevention Boolean
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    triggers List<String>
    Triggers a install-policy if there are any changes to objects in this list.

    Outputs

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

    Get an existing ManagementInstallPolicy 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?: ManagementInstallPolicyState, opts?: CustomResourceOptions): ManagementInstallPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access: Optional[bool] = None,
        desktop_security: Optional[bool] = None,
        install_on_all_cluster_members_or_fail: Optional[bool] = None,
        management_install_policy_id: Optional[str] = None,
        policy_package: Optional[str] = None,
        prepare_only: Optional[bool] = None,
        qos: Optional[bool] = None,
        revision: Optional[str] = None,
        targets: Optional[Sequence[str]] = None,
        task_id: Optional[str] = None,
        threat_prevention: Optional[bool] = None,
        triggers: Optional[Sequence[str]] = None) -> ManagementInstallPolicy
    func GetManagementInstallPolicy(ctx *Context, name string, id IDInput, state *ManagementInstallPolicyState, opts ...ResourceOption) (*ManagementInstallPolicy, error)
    public static ManagementInstallPolicy Get(string name, Input<string> id, ManagementInstallPolicyState? state, CustomResourceOptions? opts = null)
    public static ManagementInstallPolicy get(String name, Output<String> id, ManagementInstallPolicyState state, CustomResourceOptions options)
    resources:  _:    type: checkpoint:ManagementInstallPolicy    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Access bool
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    DesktopSecurity bool
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    InstallOnAllClusterMembersOrFail bool
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    ManagementInstallPolicyId string
    PolicyPackage string
    The name of the Policy Package to be installed.
    PrepareOnly bool
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    Qos bool
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    Revision string
    The UID of the revision of the policy to install.
    Targets List<string>
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    TaskId string
    Asynchronous task unique identifier.
    ThreatPrevention bool
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    Triggers List<string>
    Triggers a install-policy if there are any changes to objects in this list.
    Access bool
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    DesktopSecurity bool
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    InstallOnAllClusterMembersOrFail bool
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    ManagementInstallPolicyId string
    PolicyPackage string
    The name of the Policy Package to be installed.
    PrepareOnly bool
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    Qos bool
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    Revision string
    The UID of the revision of the policy to install.
    Targets []string
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    TaskId string
    Asynchronous task unique identifier.
    ThreatPrevention bool
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    Triggers []string
    Triggers a install-policy if there are any changes to objects in this list.
    access Boolean
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    desktopSecurity Boolean
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    installOnAllClusterMembersOrFail Boolean
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    managementInstallPolicyId String
    policyPackage String
    The name of the Policy Package to be installed.
    prepareOnly Boolean
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    qos Boolean
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    revision String
    The UID of the revision of the policy to install.
    targets List<String>
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    taskId String
    Asynchronous task unique identifier.
    threatPrevention Boolean
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    triggers List<String>
    Triggers a install-policy if there are any changes to objects in this list.
    access boolean
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    desktopSecurity boolean
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    installOnAllClusterMembersOrFail boolean
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    managementInstallPolicyId string
    policyPackage string
    The name of the Policy Package to be installed.
    prepareOnly boolean
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    qos boolean
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    revision string
    The UID of the revision of the policy to install.
    targets string[]
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    taskId string
    Asynchronous task unique identifier.
    threatPrevention boolean
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    triggers string[]
    Triggers a install-policy if there are any changes to objects in this list.
    access bool
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    desktop_security bool
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    install_on_all_cluster_members_or_fail bool
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    management_install_policy_id str
    policy_package str
    The name of the Policy Package to be installed.
    prepare_only bool
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    qos bool
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    revision str
    The UID of the revision of the policy to install.
    targets Sequence[str]
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    task_id str
    Asynchronous task unique identifier.
    threat_prevention bool
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    triggers Sequence[str]
    Triggers a install-policy if there are any changes to objects in this list.
    access Boolean
    Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false.
    desktopSecurity Boolean
    Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false.
    installOnAllClusterMembersOrFail Boolean
    Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster.
    managementInstallPolicyId String
    policyPackage String
    The name of the Policy Package to be installed.
    prepareOnly Boolean
    If true, prepares the policy for the installation, but doesn't install it on an installation target.
    qos Boolean
    Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false.
    revision String
    The UID of the revision of the policy to install.
    targets List<String>
    On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
    taskId String
    Asynchronous task unique identifier.
    threatPrevention Boolean
    Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false.
    triggers List<String>
    Triggers a install-policy if there are any changes to objects in this list.

    Package Details

    Repository
    checkpoint checkpointsw/terraform-provider-checkpoint
    License
    Notes
    This Pulumi package is based on the checkpoint Terraform Provider.
    checkpoint logo
    checkpoint 2.9.0 published on Monday, Apr 14, 2025 by checkpointsw
    checkpointsw/terraform-provider-checkpoint