checkpoint.ManagementNetworkProbe
Explore with Pulumi AI
This resource allows you to execute Check Point Network Probe.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as checkpoint from "@pulumi/checkpoint";
const example = new checkpoint.ManagementNetworkProbe("example", {
icmpOptions: {
destination: "host2",
source: "host1",
},
installOns: [
"gw1",
"gw2",
],
interval: 20,
protocol: "icmp",
});
import pulumi
import pulumi_checkpoint as checkpoint
example = checkpoint.ManagementNetworkProbe("example",
icmp_options={
"destination": "host2",
"source": "host1",
},
install_ons=[
"gw1",
"gw2",
],
interval=20,
protocol="icmp")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/checkpoint/v2/checkpoint"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := checkpoint.NewManagementNetworkProbe(ctx, "example", &checkpoint.ManagementNetworkProbeArgs{
IcmpOptions: pulumi.StringMap{
"destination": pulumi.String("host2"),
"source": pulumi.String("host1"),
},
InstallOns: pulumi.StringArray{
pulumi.String("gw1"),
pulumi.String("gw2"),
},
Interval: pulumi.Float64(20),
Protocol: pulumi.String("icmp"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkpoint = Pulumi.Checkpoint;
return await Deployment.RunAsync(() =>
{
var example = new Checkpoint.ManagementNetworkProbe("example", new()
{
IcmpOptions =
{
{ "destination", "host2" },
{ "source", "host1" },
},
InstallOns = new[]
{
"gw1",
"gw2",
},
Interval = 20,
Protocol = "icmp",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkpoint.ManagementNetworkProbe;
import com.pulumi.checkpoint.ManagementNetworkProbeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ManagementNetworkProbe("example", ManagementNetworkProbeArgs.builder()
.icmpOptions(Map.ofEntries(
Map.entry("destination", "host2"),
Map.entry("source", "host1")
))
.installOns(
"gw1",
"gw2")
.interval("20")
.protocol("icmp")
.build());
}
}
resources:
example:
type: checkpoint:ManagementNetworkProbe
properties:
icmpOptions:
destination: host2
source: host1
installOns:
- gw1
- gw2
interval: '20'
protocol: icmp
Create ManagementNetworkProbe Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ManagementNetworkProbe(name: string, args: ManagementNetworkProbeArgs, opts?: CustomResourceOptions);
@overload
def ManagementNetworkProbe(resource_name: str,
args: ManagementNetworkProbeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ManagementNetworkProbe(resource_name: str,
opts: Optional[ResourceOptions] = None,
install_ons: Optional[Sequence[str]] = None,
icmp_options: Optional[Mapping[str, str]] = None,
http_options: Optional[Mapping[str, str]] = None,
color: Optional[str] = None,
ignore_errors: Optional[bool] = None,
ignore_warnings: Optional[bool] = None,
comments: Optional[str] = None,
interval: Optional[float] = None,
management_network_probe_id: Optional[str] = None,
name: Optional[str] = None,
protocol: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
timeout: Optional[float] = None)
func NewManagementNetworkProbe(ctx *Context, name string, args ManagementNetworkProbeArgs, opts ...ResourceOption) (*ManagementNetworkProbe, error)
public ManagementNetworkProbe(string name, ManagementNetworkProbeArgs args, CustomResourceOptions? opts = null)
public ManagementNetworkProbe(String name, ManagementNetworkProbeArgs args)
public ManagementNetworkProbe(String name, ManagementNetworkProbeArgs args, CustomResourceOptions options)
type: checkpoint:ManagementNetworkProbe
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 ManagementNetworkProbeArgs
- 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 ManagementNetworkProbeArgs
- 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 ManagementNetworkProbeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ManagementNetworkProbeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ManagementNetworkProbeArgs
- 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 managementNetworkProbeResource = new Checkpoint.ManagementNetworkProbe("managementNetworkProbeResource", new()
{
InstallOns = new[]
{
"string",
},
IcmpOptions =
{
{ "string", "string" },
},
HttpOptions =
{
{ "string", "string" },
},
Color = "string",
IgnoreErrors = false,
IgnoreWarnings = false,
Comments = "string",
Interval = 0,
ManagementNetworkProbeId = "string",
Name = "string",
Protocol = "string",
Tags = new[]
{
"string",
},
Timeout = 0,
});
example, err := checkpoint.NewManagementNetworkProbe(ctx, "managementNetworkProbeResource", &checkpoint.ManagementNetworkProbeArgs{
InstallOns: pulumi.StringArray{
pulumi.String("string"),
},
IcmpOptions: pulumi.StringMap{
"string": pulumi.String("string"),
},
HttpOptions: pulumi.StringMap{
"string": pulumi.String("string"),
},
Color: pulumi.String("string"),
IgnoreErrors: pulumi.Bool(false),
IgnoreWarnings: pulumi.Bool(false),
Comments: pulumi.String("string"),
Interval: pulumi.Float64(0),
ManagementNetworkProbeId: pulumi.String("string"),
Name: pulumi.String("string"),
Protocol: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeout: pulumi.Float64(0),
})
var managementNetworkProbeResource = new ManagementNetworkProbe("managementNetworkProbeResource", ManagementNetworkProbeArgs.builder()
.installOns("string")
.icmpOptions(Map.of("string", "string"))
.httpOptions(Map.of("string", "string"))
.color("string")
.ignoreErrors(false)
.ignoreWarnings(false)
.comments("string")
.interval(0)
.managementNetworkProbeId("string")
.name("string")
.protocol("string")
.tags("string")
.timeout(0)
.build());
management_network_probe_resource = checkpoint.ManagementNetworkProbe("managementNetworkProbeResource",
install_ons=["string"],
icmp_options={
"string": "string",
},
http_options={
"string": "string",
},
color="string",
ignore_errors=False,
ignore_warnings=False,
comments="string",
interval=0,
management_network_probe_id="string",
name="string",
protocol="string",
tags=["string"],
timeout=0)
const managementNetworkProbeResource = new checkpoint.ManagementNetworkProbe("managementNetworkProbeResource", {
installOns: ["string"],
icmpOptions: {
string: "string",
},
httpOptions: {
string: "string",
},
color: "string",
ignoreErrors: false,
ignoreWarnings: false,
comments: "string",
interval: 0,
managementNetworkProbeId: "string",
name: "string",
protocol: "string",
tags: ["string"],
timeout: 0,
});
type: checkpoint:ManagementNetworkProbe
properties:
color: string
comments: string
httpOptions:
string: string
icmpOptions:
string: string
ignoreErrors: false
ignoreWarnings: false
installOns:
- string
interval: 0
managementNetworkProbeId: string
name: string
protocol: string
tags:
- string
timeout: 0
ManagementNetworkProbe 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 ManagementNetworkProbe resource accepts the following input properties:
- Install
Ons List<string> - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- Color string
- Color of the object. Should be one of existing colors.
- Comments string
- Comments string.
- Http
Options Dictionary<string, string> - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- Icmp
Options Dictionary<string, string> - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- Ignore
Errors bool - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- Ignore
Warnings bool - Apply changes ignoring warnings.
- Interval double
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- Management
Network stringProbe Id - Name string
- Object name.
- Protocol string
- The probing protocol to use.
- List<string>
- Collection of tag identifiers.tags blocks are documented below.
- Timeout double
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- Install
Ons []string - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- Color string
- Color of the object. Should be one of existing colors.
- Comments string
- Comments string.
- Http
Options map[string]string - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- Icmp
Options map[string]string - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- Ignore
Errors bool - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- Ignore
Warnings bool - Apply changes ignoring warnings.
- Interval float64
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- Management
Network stringProbe Id - Name string
- Object name.
- Protocol string
- The probing protocol to use.
- []string
- Collection of tag identifiers.tags blocks are documented below.
- Timeout float64
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- install
Ons List<String> - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- color String
- Color of the object. Should be one of existing colors.
- comments String
- Comments string.
- http
Options Map<String,String> - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- icmp
Options Map<String,String> - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- ignore
Errors Boolean - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- ignore
Warnings Boolean - Apply changes ignoring warnings.
- interval Double
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- management
Network StringProbe Id - name String
- Object name.
- protocol String
- The probing protocol to use.
- List<String>
- Collection of tag identifiers.tags blocks are documented below.
- timeout Double
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- install
Ons string[] - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- color string
- Color of the object. Should be one of existing colors.
- comments string
- Comments string.
- http
Options {[key: string]: string} - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- icmp
Options {[key: string]: string} - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- ignore
Errors boolean - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- ignore
Warnings boolean - Apply changes ignoring warnings.
- interval number
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- management
Network stringProbe Id - name string
- Object name.
- protocol string
- The probing protocol to use.
- string[]
- Collection of tag identifiers.tags blocks are documented below.
- timeout number
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- install_
ons Sequence[str] - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- color str
- Color of the object. Should be one of existing colors.
- comments str
- Comments string.
- http_
options Mapping[str, str] - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- icmp_
options Mapping[str, str] - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- ignore_
errors bool - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- ignore_
warnings bool - Apply changes ignoring warnings.
- interval float
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- management_
network_ strprobe_ id - name str
- Object name.
- protocol str
- The probing protocol to use.
- Sequence[str]
- Collection of tag identifiers.tags blocks are documented below.
- timeout float
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- install
Ons List<String> - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- color String
- Color of the object. Should be one of existing colors.
- comments String
- Comments string.
- http
Options Map<String> - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- icmp
Options Map<String> - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- ignore
Errors Boolean - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- ignore
Warnings Boolean - Apply changes ignoring warnings.
- interval Number
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- management
Network StringProbe Id - name String
- Object name.
- protocol String
- The probing protocol to use.
- List<String>
- Collection of tag identifiers.tags blocks are documented below.
- timeout Number
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
Outputs
All input properties are implicitly available as output properties. Additionally, the ManagementNetworkProbe resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ManagementNetworkProbe Resource
Get an existing ManagementNetworkProbe 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?: ManagementNetworkProbeState, opts?: CustomResourceOptions): ManagementNetworkProbe
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
color: Optional[str] = None,
comments: Optional[str] = None,
http_options: Optional[Mapping[str, str]] = None,
icmp_options: Optional[Mapping[str, str]] = None,
ignore_errors: Optional[bool] = None,
ignore_warnings: Optional[bool] = None,
install_ons: Optional[Sequence[str]] = None,
interval: Optional[float] = None,
management_network_probe_id: Optional[str] = None,
name: Optional[str] = None,
protocol: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
timeout: Optional[float] = None) -> ManagementNetworkProbe
func GetManagementNetworkProbe(ctx *Context, name string, id IDInput, state *ManagementNetworkProbeState, opts ...ResourceOption) (*ManagementNetworkProbe, error)
public static ManagementNetworkProbe Get(string name, Input<string> id, ManagementNetworkProbeState? state, CustomResourceOptions? opts = null)
public static ManagementNetworkProbe get(String name, Output<String> id, ManagementNetworkProbeState state, CustomResourceOptions options)
resources: _: type: checkpoint:ManagementNetworkProbe 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.
- Color string
- Color of the object. Should be one of existing colors.
- Comments string
- Comments string.
- Http
Options Dictionary<string, string> - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- Icmp
Options Dictionary<string, string> - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- Ignore
Errors bool - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- Ignore
Warnings bool - Apply changes ignoring warnings.
- Install
Ons List<string> - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- Interval double
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- Management
Network stringProbe Id - Name string
- Object name.
- Protocol string
- The probing protocol to use.
- List<string>
- Collection of tag identifiers.tags blocks are documented below.
- Timeout double
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- Color string
- Color of the object. Should be one of existing colors.
- Comments string
- Comments string.
- Http
Options map[string]string - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- Icmp
Options map[string]string - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- Ignore
Errors bool - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- Ignore
Warnings bool - Apply changes ignoring warnings.
- Install
Ons []string - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- Interval float64
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- Management
Network stringProbe Id - Name string
- Object name.
- Protocol string
- The probing protocol to use.
- []string
- Collection of tag identifiers.tags blocks are documented below.
- Timeout float64
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- color String
- Color of the object. Should be one of existing colors.
- comments String
- Comments string.
- http
Options Map<String,String> - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- icmp
Options Map<String,String> - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- ignore
Errors Boolean - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- ignore
Warnings Boolean - Apply changes ignoring warnings.
- install
Ons List<String> - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- interval Double
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- management
Network StringProbe Id - name String
- Object name.
- protocol String
- The probing protocol to use.
- List<String>
- Collection of tag identifiers.tags blocks are documented below.
- timeout Double
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- color string
- Color of the object. Should be one of existing colors.
- comments string
- Comments string.
- http
Options {[key: string]: string} - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- icmp
Options {[key: string]: string} - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- ignore
Errors boolean - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- ignore
Warnings boolean - Apply changes ignoring warnings.
- install
Ons string[] - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- interval number
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- management
Network stringProbe Id - name string
- Object name.
- protocol string
- The probing protocol to use.
- string[]
- Collection of tag identifiers.tags blocks are documented below.
- timeout number
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- color str
- Color of the object. Should be one of existing colors.
- comments str
- Comments string.
- http_
options Mapping[str, str] - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- icmp_
options Mapping[str, str] - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- ignore_
errors bool - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- ignore_
warnings bool - Apply changes ignoring warnings.
- install_
ons Sequence[str] - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- interval float
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- management_
network_ strprobe_ id - name str
- Object name.
- protocol str
- The probing protocol to use.
- Sequence[str]
- Collection of tag identifiers.tags blocks are documented below.
- timeout float
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
- color String
- Color of the object. Should be one of existing colors.
- comments String
- Comments string.
- http
Options Map<String> - Additional options when [protocol] is set to "http".http_options blocks are documented below.
- icmp
Options Map<String> - Additional options when [protocol] is set to "icmp".icmp_options blocks are documented below.
- ignore
Errors Boolean - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
- ignore
Warnings Boolean - Apply changes ignoring warnings.
- install
Ons List<String> - Collection of Check Point Security Gateways that generate the probe, identified by name or UID.install_on blocks are documented below.
- interval Number
- The time interval (in seconds) between each probe request.Best Practice - The interval value should be lower than the timeout value.
- management
Network StringProbe Id - name String
- Object name.
- protocol String
- The probing protocol to use.
- List<String>
- Collection of tag identifiers.tags blocks are documented below.
- timeout Number
- The probe expiration timeout (in seconds). If there is not a single reply within this time, the status of the probe changes to "Down".
Package Details
- Repository
- checkpoint checkpointsw/terraform-provider-checkpoint
- License
- Notes
- This Pulumi package is based on the
checkpoint
Terraform Provider.