published on Monday, Jun 15, 2026 by checkpointsw
published on Monday, Jun 15, 2026 by checkpointsw
Create GaiaCommandSetPim Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GaiaCommandSetPim(name: string, args?: GaiaCommandSetPimArgs, opts?: CustomResourceOptions);@overload
def GaiaCommandSetPim(resource_name: str,
args: Optional[GaiaCommandSetPimArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def GaiaCommandSetPim(resource_name: str,
opts: Optional[ResourceOptions] = None,
assert_interval: Optional[str] = None,
assert_rank: Optional[GaiaCommandSetPimAssertRankArgs] = None,
bootstrap_candidate: Optional[GaiaCommandSetPimBootstrapCandidateArgs] = None,
candidate_rp: Optional[GaiaCommandSetPimCandidateRpArgs] = None,
custom_ssm_prefixes: Optional[Sequence[GaiaCommandSetPimCustomSsmPrefixArgs]] = None,
data_interval: Optional[str] = None,
debug: Optional[bool] = None,
enable_state_refresh: Optional[bool] = None,
gaia_command_set_pim_id: Optional[str] = None,
hello_interval: Optional[str] = None,
jp_delay_interval: Optional[str] = None,
jp_interval: Optional[str] = None,
mode: Optional[str] = None,
register_suppress_interval: Optional[str] = None,
spt_thresholds: Optional[Sequence[GaiaCommandSetPimSptThresholdArgs]] = None,
state_refresh_interval: Optional[str] = None,
state_refresh_ttl: Optional[str] = None,
static_rp: Optional[GaiaCommandSetPimStaticRpArgs] = None)func NewGaiaCommandSetPim(ctx *Context, name string, args *GaiaCommandSetPimArgs, opts ...ResourceOption) (*GaiaCommandSetPim, error)public GaiaCommandSetPim(string name, GaiaCommandSetPimArgs? args = null, CustomResourceOptions? opts = null)
public GaiaCommandSetPim(String name, GaiaCommandSetPimArgs args)
public GaiaCommandSetPim(String name, GaiaCommandSetPimArgs args, CustomResourceOptions options)
type: checkpoint:GaiaCommandSetPim
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "checkpoint_gaiacommandsetpim" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GaiaCommandSetPimArgs
- 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 GaiaCommandSetPimArgs
- 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 GaiaCommandSetPimArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GaiaCommandSetPimArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GaiaCommandSetPimArgs
- 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 gaiaCommandSetPimResource = new Checkpoint.GaiaCommandSetPim("gaiaCommandSetPimResource", new()
{
AssertInterval = "string",
AssertRank = new Checkpoint.Inputs.GaiaCommandSetPimAssertRankArgs
{
Protocol = "string",
Rank = "string",
},
BootstrapCandidate = new Checkpoint.Inputs.GaiaCommandSetPimBootstrapCandidateArgs
{
Enable = false,
LocalAddress = "string",
Priority = "string",
},
CandidateRp = new Checkpoint.Inputs.GaiaCommandSetPimCandidateRpArgs
{
AdvertiseInterval = 0,
Enable = false,
LocalAddress = "string",
MulticastGroup = new Checkpoint.Inputs.GaiaCommandSetPimCandidateRpMulticastGroupArgs
{
Address = "string",
},
Priority = 0,
},
CustomSsmPrefixes = new[]
{
new Checkpoint.Inputs.GaiaCommandSetPimCustomSsmPrefixArgs
{
Address = "string",
},
},
DataInterval = "string",
Debug = false,
EnableStateRefresh = false,
GaiaCommandSetPimId = "string",
HelloInterval = "string",
JpDelayInterval = "string",
JpInterval = "string",
Mode = "string",
RegisterSuppressInterval = "string",
SptThresholds = new[]
{
new Checkpoint.Inputs.GaiaCommandSetPimSptThresholdArgs
{
MulticastGroup = "string",
Threshold = "string",
},
},
StateRefreshInterval = "string",
StateRefreshTtl = "string",
StaticRp = new Checkpoint.Inputs.GaiaCommandSetPimStaticRpArgs
{
Enable = false,
MulticastGroups = new[]
{
new Checkpoint.Inputs.GaiaCommandSetPimStaticRpMulticastGroupArgs
{
Address = "string",
},
},
RpAddress = "string",
},
});
example, err := checkpoint.NewGaiaCommandSetPim(ctx, "gaiaCommandSetPimResource", &checkpoint.GaiaCommandSetPimArgs{
AssertInterval: pulumi.String("string"),
AssertRank: &checkpoint.GaiaCommandSetPimAssertRankArgs{
Protocol: pulumi.String("string"),
Rank: pulumi.String("string"),
},
BootstrapCandidate: &checkpoint.GaiaCommandSetPimBootstrapCandidateArgs{
Enable: pulumi.Bool(false),
LocalAddress: pulumi.String("string"),
Priority: pulumi.String("string"),
},
CandidateRp: &checkpoint.GaiaCommandSetPimCandidateRpArgs{
AdvertiseInterval: pulumi.Float64(0),
Enable: pulumi.Bool(false),
LocalAddress: pulumi.String("string"),
MulticastGroup: &checkpoint.GaiaCommandSetPimCandidateRpMulticastGroupArgs{
Address: pulumi.String("string"),
},
Priority: pulumi.Float64(0),
},
CustomSsmPrefixes: checkpoint.GaiaCommandSetPimCustomSsmPrefixArray{
&checkpoint.GaiaCommandSetPimCustomSsmPrefixArgs{
Address: pulumi.String("string"),
},
},
DataInterval: pulumi.String("string"),
Debug: pulumi.Bool(false),
EnableStateRefresh: pulumi.Bool(false),
GaiaCommandSetPimId: pulumi.String("string"),
HelloInterval: pulumi.String("string"),
JpDelayInterval: pulumi.String("string"),
JpInterval: pulumi.String("string"),
Mode: pulumi.String("string"),
RegisterSuppressInterval: pulumi.String("string"),
SptThresholds: checkpoint.GaiaCommandSetPimSptThresholdArray{
&checkpoint.GaiaCommandSetPimSptThresholdArgs{
MulticastGroup: pulumi.String("string"),
Threshold: pulumi.String("string"),
},
},
StateRefreshInterval: pulumi.String("string"),
StateRefreshTtl: pulumi.String("string"),
StaticRp: &checkpoint.GaiaCommandSetPimStaticRpArgs{
Enable: pulumi.Bool(false),
MulticastGroups: checkpoint.GaiaCommandSetPimStaticRpMulticastGroupArray{
&checkpoint.GaiaCommandSetPimStaticRpMulticastGroupArgs{
Address: pulumi.String("string"),
},
},
RpAddress: pulumi.String("string"),
},
})
resource "checkpoint_gaiacommandsetpim" "gaiaCommandSetPimResource" {
assert_interval = "string"
assert_rank = {
protocol = "string"
rank = "string"
}
bootstrap_candidate = {
enable = false
local_address = "string"
priority = "string"
}
candidate_rp = {
advertise_interval = 0
enable = false
local_address = "string"
multicast_group = {
address = "string"
}
priority = 0
}
custom_ssm_prefixes {
address = "string"
}
data_interval = "string"
debug = false
enable_state_refresh = false
gaia_command_set_pim_id = "string"
hello_interval = "string"
jp_delay_interval = "string"
jp_interval = "string"
mode = "string"
register_suppress_interval = "string"
spt_thresholds {
multicast_group = "string"
threshold = "string"
}
state_refresh_interval = "string"
state_refresh_ttl = "string"
static_rp = {
enable = false
multicast_groups = [{
"address" = "string"
}]
rp_address = "string"
}
}
var gaiaCommandSetPimResource = new GaiaCommandSetPim("gaiaCommandSetPimResource", GaiaCommandSetPimArgs.builder()
.assertInterval("string")
.assertRank(GaiaCommandSetPimAssertRankArgs.builder()
.protocol("string")
.rank("string")
.build())
.bootstrapCandidate(GaiaCommandSetPimBootstrapCandidateArgs.builder()
.enable(false)
.localAddress("string")
.priority("string")
.build())
.candidateRp(GaiaCommandSetPimCandidateRpArgs.builder()
.advertiseInterval(0.0)
.enable(false)
.localAddress("string")
.multicastGroup(GaiaCommandSetPimCandidateRpMulticastGroupArgs.builder()
.address("string")
.build())
.priority(0.0)
.build())
.customSsmPrefixes(GaiaCommandSetPimCustomSsmPrefixArgs.builder()
.address("string")
.build())
.dataInterval("string")
.debug(false)
.enableStateRefresh(false)
.gaiaCommandSetPimId("string")
.helloInterval("string")
.jpDelayInterval("string")
.jpInterval("string")
.mode("string")
.registerSuppressInterval("string")
.sptThresholds(GaiaCommandSetPimSptThresholdArgs.builder()
.multicastGroup("string")
.threshold("string")
.build())
.stateRefreshInterval("string")
.stateRefreshTtl("string")
.staticRp(GaiaCommandSetPimStaticRpArgs.builder()
.enable(false)
.multicastGroups(GaiaCommandSetPimStaticRpMulticastGroupArgs.builder()
.address("string")
.build())
.rpAddress("string")
.build())
.build());
gaia_command_set_pim_resource = checkpoint.GaiaCommandSetPim("gaiaCommandSetPimResource",
assert_interval="string",
assert_rank={
"protocol": "string",
"rank": "string",
},
bootstrap_candidate={
"enable": False,
"local_address": "string",
"priority": "string",
},
candidate_rp={
"advertise_interval": float(0),
"enable": False,
"local_address": "string",
"multicast_group": {
"address": "string",
},
"priority": float(0),
},
custom_ssm_prefixes=[{
"address": "string",
}],
data_interval="string",
debug=False,
enable_state_refresh=False,
gaia_command_set_pim_id="string",
hello_interval="string",
jp_delay_interval="string",
jp_interval="string",
mode="string",
register_suppress_interval="string",
spt_thresholds=[{
"multicast_group": "string",
"threshold": "string",
}],
state_refresh_interval="string",
state_refresh_ttl="string",
static_rp={
"enable": False,
"multicast_groups": [{
"address": "string",
}],
"rp_address": "string",
})
const gaiaCommandSetPimResource = new checkpoint.GaiaCommandSetPim("gaiaCommandSetPimResource", {
assertInterval: "string",
assertRank: {
protocol: "string",
rank: "string",
},
bootstrapCandidate: {
enable: false,
localAddress: "string",
priority: "string",
},
candidateRp: {
advertiseInterval: 0,
enable: false,
localAddress: "string",
multicastGroup: {
address: "string",
},
priority: 0,
},
customSsmPrefixes: [{
address: "string",
}],
dataInterval: "string",
debug: false,
enableStateRefresh: false,
gaiaCommandSetPimId: "string",
helloInterval: "string",
jpDelayInterval: "string",
jpInterval: "string",
mode: "string",
registerSuppressInterval: "string",
sptThresholds: [{
multicastGroup: "string",
threshold: "string",
}],
stateRefreshInterval: "string",
stateRefreshTtl: "string",
staticRp: {
enable: false,
multicastGroups: [{
address: "string",
}],
rpAddress: "string",
},
});
type: checkpoint:GaiaCommandSetPim
properties:
assertInterval: string
assertRank:
protocol: string
rank: string
bootstrapCandidate:
enable: false
localAddress: string
priority: string
candidateRp:
advertiseInterval: 0
enable: false
localAddress: string
multicastGroup:
address: string
priority: 0
customSsmPrefixes:
- address: string
dataInterval: string
debug: false
enableStateRefresh: false
gaiaCommandSetPimId: string
helloInterval: string
jpDelayInterval: string
jpInterval: string
mode: string
registerSuppressInterval: string
sptThresholds:
- multicastGroup: string
threshold: string
stateRefreshInterval: string
stateRefreshTtl: string
staticRp:
enable: false
multicastGroups:
- address: string
rpAddress: string
GaiaCommandSetPim 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 GaiaCommandSetPim resource accepts the following input properties:
- Assert
Interval string - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- Assert
Rank GaiaCommand Set Pim Assert Rank - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- Bootstrap
Candidate GaiaCommand Set Pim Bootstrap Candidate - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- Candidate
Rp GaiaCommand Set Pim Candidate Rp - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- Custom
Ssm List<GaiaPrefixes Command Set Pim Custom Ssm Prefix> - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- Data
Interval string - Configure the Data Interval.
- Debug bool
- Enable debugging for this resource only.
- Enable
State boolRefresh - Configure State Refresh
- Gaia
Command stringSet Pim Id - Hello
Interval string - Configure the Hello Interval.
- Jp
Delay stringInterval - Configure the Random Delay Join/Prune Interval
- Jp
Interval string - Configure the Join/Prune Interval (PIM-SM/SSM only).
- Mode string
- Configure Dense Mode/Sparse Mode/SSM Mode
- Register
Suppress stringInterval - Configure Register-Suppression Interval
- Spt
Thresholds List<GaiaCommand Set Pim Spt Threshold> - Configure SPT Threshold spt_threshold blocks are documented below.
- State
Refresh stringInterval - Configure State Refresh Interval
- State
Refresh stringTtl - Configure State Refresh TTL
- Static
Rp GaiaCommand Set Pim Static Rp - Configure Static Rendezvous Point static_rp blocks are documented below.
- Assert
Interval string - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- Assert
Rank GaiaCommand Set Pim Assert Rank Args - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- Bootstrap
Candidate GaiaCommand Set Pim Bootstrap Candidate Args - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- Candidate
Rp GaiaCommand Set Pim Candidate Rp Args - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- Custom
Ssm []GaiaPrefixes Command Set Pim Custom Ssm Prefix Args - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- Data
Interval string - Configure the Data Interval.
- Debug bool
- Enable debugging for this resource only.
- Enable
State boolRefresh - Configure State Refresh
- Gaia
Command stringSet Pim Id - Hello
Interval string - Configure the Hello Interval.
- Jp
Delay stringInterval - Configure the Random Delay Join/Prune Interval
- Jp
Interval string - Configure the Join/Prune Interval (PIM-SM/SSM only).
- Mode string
- Configure Dense Mode/Sparse Mode/SSM Mode
- Register
Suppress stringInterval - Configure Register-Suppression Interval
- Spt
Thresholds []GaiaCommand Set Pim Spt Threshold Args - Configure SPT Threshold spt_threshold blocks are documented below.
- State
Refresh stringInterval - Configure State Refresh Interval
- State
Refresh stringTtl - Configure State Refresh TTL
- Static
Rp GaiaCommand Set Pim Static Rp Args - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert_
interval string - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert_
rank object - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap_
candidate object - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate_
rp object - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom_
ssm_ list(object)prefixes - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data_
interval string - Configure the Data Interval.
- debug bool
- Enable debugging for this resource only.
- enable_
state_ boolrefresh - Configure State Refresh
- gaia_
command_ stringset_ pim_ id - hello_
interval string - Configure the Hello Interval.
- jp_
delay_ stringinterval - Configure the Random Delay Join/Prune Interval
- jp_
interval string - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode string
- Configure Dense Mode/Sparse Mode/SSM Mode
- register_
suppress_ stringinterval - Configure Register-Suppression Interval
- spt_
thresholds list(object) - Configure SPT Threshold spt_threshold blocks are documented below.
- state_
refresh_ stringinterval - Configure State Refresh Interval
- state_
refresh_ stringttl - Configure State Refresh TTL
- static_
rp object - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert
Interval String - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert
Rank GaiaCommand Set Pim Assert Rank - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap
Candidate GaiaCommand Set Pim Bootstrap Candidate - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate
Rp GaiaCommand Set Pim Candidate Rp - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom
Ssm List<GaiaPrefixes Command Set Pim Custom Ssm Prefix> - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data
Interval String - Configure the Data Interval.
- debug Boolean
- Enable debugging for this resource only.
- enable
State BooleanRefresh - Configure State Refresh
- gaia
Command StringSet Pim Id - hello
Interval String - Configure the Hello Interval.
- jp
Delay StringInterval - Configure the Random Delay Join/Prune Interval
- jp
Interval String - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode String
- Configure Dense Mode/Sparse Mode/SSM Mode
- register
Suppress StringInterval - Configure Register-Suppression Interval
- spt
Thresholds List<GaiaCommand Set Pim Spt Threshold> - Configure SPT Threshold spt_threshold blocks are documented below.
- state
Refresh StringInterval - Configure State Refresh Interval
- state
Refresh StringTtl - Configure State Refresh TTL
- static
Rp GaiaCommand Set Pim Static Rp - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert
Interval string - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert
Rank GaiaCommand Set Pim Assert Rank - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap
Candidate GaiaCommand Set Pim Bootstrap Candidate - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate
Rp GaiaCommand Set Pim Candidate Rp - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom
Ssm GaiaPrefixes Command Set Pim Custom Ssm Prefix[] - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data
Interval string - Configure the Data Interval.
- debug boolean
- Enable debugging for this resource only.
- enable
State booleanRefresh - Configure State Refresh
- gaia
Command stringSet Pim Id - hello
Interval string - Configure the Hello Interval.
- jp
Delay stringInterval - Configure the Random Delay Join/Prune Interval
- jp
Interval string - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode string
- Configure Dense Mode/Sparse Mode/SSM Mode
- register
Suppress stringInterval - Configure Register-Suppression Interval
- spt
Thresholds GaiaCommand Set Pim Spt Threshold[] - Configure SPT Threshold spt_threshold blocks are documented below.
- state
Refresh stringInterval - Configure State Refresh Interval
- state
Refresh stringTtl - Configure State Refresh TTL
- static
Rp GaiaCommand Set Pim Static Rp - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert_
interval str - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert_
rank GaiaCommand Set Pim Assert Rank Args - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap_
candidate GaiaCommand Set Pim Bootstrap Candidate Args - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate_
rp GaiaCommand Set Pim Candidate Rp Args - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom_
ssm_ Sequence[Gaiaprefixes Command Set Pim Custom Ssm Prefix Args] - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data_
interval str - Configure the Data Interval.
- debug bool
- Enable debugging for this resource only.
- enable_
state_ boolrefresh - Configure State Refresh
- gaia_
command_ strset_ pim_ id - hello_
interval str - Configure the Hello Interval.
- jp_
delay_ strinterval - Configure the Random Delay Join/Prune Interval
- jp_
interval str - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode str
- Configure Dense Mode/Sparse Mode/SSM Mode
- register_
suppress_ strinterval - Configure Register-Suppression Interval
- spt_
thresholds Sequence[GaiaCommand Set Pim Spt Threshold Args] - Configure SPT Threshold spt_threshold blocks are documented below.
- state_
refresh_ strinterval - Configure State Refresh Interval
- state_
refresh_ strttl - Configure State Refresh TTL
- static_
rp GaiaCommand Set Pim Static Rp Args - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert
Interval String - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert
Rank Property Map - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap
Candidate Property Map - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate
Rp Property Map - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom
Ssm List<Property Map>Prefixes - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data
Interval String - Configure the Data Interval.
- debug Boolean
- Enable debugging for this resource only.
- enable
State BooleanRefresh - Configure State Refresh
- gaia
Command StringSet Pim Id - hello
Interval String - Configure the Hello Interval.
- jp
Delay StringInterval - Configure the Random Delay Join/Prune Interval
- jp
Interval String - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode String
- Configure Dense Mode/Sparse Mode/SSM Mode
- register
Suppress StringInterval - Configure Register-Suppression Interval
- spt
Thresholds List<Property Map> - Configure SPT Threshold spt_threshold blocks are documented below.
- state
Refresh StringInterval - Configure State Refresh Interval
- state
Refresh StringTtl - Configure State Refresh TTL
- static
Rp Property Map - Configure Static Rendezvous Point static_rp blocks are documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the GaiaCommandSetPim 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 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 GaiaCommandSetPim Resource
Get an existing GaiaCommandSetPim 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?: GaiaCommandSetPimState, opts?: CustomResourceOptions): GaiaCommandSetPim@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
assert_interval: Optional[str] = None,
assert_rank: Optional[GaiaCommandSetPimAssertRankArgs] = None,
bootstrap_candidate: Optional[GaiaCommandSetPimBootstrapCandidateArgs] = None,
candidate_rp: Optional[GaiaCommandSetPimCandidateRpArgs] = None,
custom_ssm_prefixes: Optional[Sequence[GaiaCommandSetPimCustomSsmPrefixArgs]] = None,
data_interval: Optional[str] = None,
debug: Optional[bool] = None,
enable_state_refresh: Optional[bool] = None,
gaia_command_set_pim_id: Optional[str] = None,
hello_interval: Optional[str] = None,
jp_delay_interval: Optional[str] = None,
jp_interval: Optional[str] = None,
mode: Optional[str] = None,
register_suppress_interval: Optional[str] = None,
spt_thresholds: Optional[Sequence[GaiaCommandSetPimSptThresholdArgs]] = None,
state_refresh_interval: Optional[str] = None,
state_refresh_ttl: Optional[str] = None,
static_rp: Optional[GaiaCommandSetPimStaticRpArgs] = None) -> GaiaCommandSetPimfunc GetGaiaCommandSetPim(ctx *Context, name string, id IDInput, state *GaiaCommandSetPimState, opts ...ResourceOption) (*GaiaCommandSetPim, error)public static GaiaCommandSetPim Get(string name, Input<string> id, GaiaCommandSetPimState? state, CustomResourceOptions? opts = null)public static GaiaCommandSetPim get(String name, Output<String> id, GaiaCommandSetPimState state, CustomResourceOptions options)resources: _: type: checkpoint:GaiaCommandSetPim get: id: ${id}import {
to = checkpoint_gaiacommandsetpim.example
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.
- Assert
Interval string - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- Assert
Rank GaiaCommand Set Pim Assert Rank - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- Bootstrap
Candidate GaiaCommand Set Pim Bootstrap Candidate - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- Candidate
Rp GaiaCommand Set Pim Candidate Rp - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- Custom
Ssm List<GaiaPrefixes Command Set Pim Custom Ssm Prefix> - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- Data
Interval string - Configure the Data Interval.
- Debug bool
- Enable debugging for this resource only.
- Enable
State boolRefresh - Configure State Refresh
- Gaia
Command stringSet Pim Id - Hello
Interval string - Configure the Hello Interval.
- Jp
Delay stringInterval - Configure the Random Delay Join/Prune Interval
- Jp
Interval string - Configure the Join/Prune Interval (PIM-SM/SSM only).
- Mode string
- Configure Dense Mode/Sparse Mode/SSM Mode
- Register
Suppress stringInterval - Configure Register-Suppression Interval
- Spt
Thresholds List<GaiaCommand Set Pim Spt Threshold> - Configure SPT Threshold spt_threshold blocks are documented below.
- State
Refresh stringInterval - Configure State Refresh Interval
- State
Refresh stringTtl - Configure State Refresh TTL
- Static
Rp GaiaCommand Set Pim Static Rp - Configure Static Rendezvous Point static_rp blocks are documented below.
- Assert
Interval string - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- Assert
Rank GaiaCommand Set Pim Assert Rank Args - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- Bootstrap
Candidate GaiaCommand Set Pim Bootstrap Candidate Args - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- Candidate
Rp GaiaCommand Set Pim Candidate Rp Args - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- Custom
Ssm []GaiaPrefixes Command Set Pim Custom Ssm Prefix Args - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- Data
Interval string - Configure the Data Interval.
- Debug bool
- Enable debugging for this resource only.
- Enable
State boolRefresh - Configure State Refresh
- Gaia
Command stringSet Pim Id - Hello
Interval string - Configure the Hello Interval.
- Jp
Delay stringInterval - Configure the Random Delay Join/Prune Interval
- Jp
Interval string - Configure the Join/Prune Interval (PIM-SM/SSM only).
- Mode string
- Configure Dense Mode/Sparse Mode/SSM Mode
- Register
Suppress stringInterval - Configure Register-Suppression Interval
- Spt
Thresholds []GaiaCommand Set Pim Spt Threshold Args - Configure SPT Threshold spt_threshold blocks are documented below.
- State
Refresh stringInterval - Configure State Refresh Interval
- State
Refresh stringTtl - Configure State Refresh TTL
- Static
Rp GaiaCommand Set Pim Static Rp Args - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert_
interval string - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert_
rank object - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap_
candidate object - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate_
rp object - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom_
ssm_ list(object)prefixes - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data_
interval string - Configure the Data Interval.
- debug bool
- Enable debugging for this resource only.
- enable_
state_ boolrefresh - Configure State Refresh
- gaia_
command_ stringset_ pim_ id - hello_
interval string - Configure the Hello Interval.
- jp_
delay_ stringinterval - Configure the Random Delay Join/Prune Interval
- jp_
interval string - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode string
- Configure Dense Mode/Sparse Mode/SSM Mode
- register_
suppress_ stringinterval - Configure Register-Suppression Interval
- spt_
thresholds list(object) - Configure SPT Threshold spt_threshold blocks are documented below.
- state_
refresh_ stringinterval - Configure State Refresh Interval
- state_
refresh_ stringttl - Configure State Refresh TTL
- static_
rp object - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert
Interval String - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert
Rank GaiaCommand Set Pim Assert Rank - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap
Candidate GaiaCommand Set Pim Bootstrap Candidate - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate
Rp GaiaCommand Set Pim Candidate Rp - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom
Ssm List<GaiaPrefixes Command Set Pim Custom Ssm Prefix> - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data
Interval String - Configure the Data Interval.
- debug Boolean
- Enable debugging for this resource only.
- enable
State BooleanRefresh - Configure State Refresh
- gaia
Command StringSet Pim Id - hello
Interval String - Configure the Hello Interval.
- jp
Delay StringInterval - Configure the Random Delay Join/Prune Interval
- jp
Interval String - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode String
- Configure Dense Mode/Sparse Mode/SSM Mode
- register
Suppress StringInterval - Configure Register-Suppression Interval
- spt
Thresholds List<GaiaCommand Set Pim Spt Threshold> - Configure SPT Threshold spt_threshold blocks are documented below.
- state
Refresh StringInterval - Configure State Refresh Interval
- state
Refresh StringTtl - Configure State Refresh TTL
- static
Rp GaiaCommand Set Pim Static Rp - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert
Interval string - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert
Rank GaiaCommand Set Pim Assert Rank - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap
Candidate GaiaCommand Set Pim Bootstrap Candidate - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate
Rp GaiaCommand Set Pim Candidate Rp - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom
Ssm GaiaPrefixes Command Set Pim Custom Ssm Prefix[] - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data
Interval string - Configure the Data Interval.
- debug boolean
- Enable debugging for this resource only.
- enable
State booleanRefresh - Configure State Refresh
- gaia
Command stringSet Pim Id - hello
Interval string - Configure the Hello Interval.
- jp
Delay stringInterval - Configure the Random Delay Join/Prune Interval
- jp
Interval string - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode string
- Configure Dense Mode/Sparse Mode/SSM Mode
- register
Suppress stringInterval - Configure Register-Suppression Interval
- spt
Thresholds GaiaCommand Set Pim Spt Threshold[] - Configure SPT Threshold spt_threshold blocks are documented below.
- state
Refresh stringInterval - Configure State Refresh Interval
- state
Refresh stringTtl - Configure State Refresh TTL
- static
Rp GaiaCommand Set Pim Static Rp - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert_
interval str - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert_
rank GaiaCommand Set Pim Assert Rank Args - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap_
candidate GaiaCommand Set Pim Bootstrap Candidate Args - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate_
rp GaiaCommand Set Pim Candidate Rp Args - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom_
ssm_ Sequence[Gaiaprefixes Command Set Pim Custom Ssm Prefix Args] - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data_
interval str - Configure the Data Interval.
- debug bool
- Enable debugging for this resource only.
- enable_
state_ boolrefresh - Configure State Refresh
- gaia_
command_ strset_ pim_ id - hello_
interval str - Configure the Hello Interval.
- jp_
delay_ strinterval - Configure the Random Delay Join/Prune Interval
- jp_
interval str - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode str
- Configure Dense Mode/Sparse Mode/SSM Mode
- register_
suppress_ strinterval - Configure Register-Suppression Interval
- spt_
thresholds Sequence[GaiaCommand Set Pim Spt Threshold Args] - Configure SPT Threshold spt_threshold blocks are documented below.
- state_
refresh_ strinterval - Configure State Refresh Interval
- state_
refresh_ strttl - Configure State Refresh TTL
- static_
rp GaiaCommand Set Pim Static Rp Args - Configure Static Rendezvous Point static_rp blocks are documented below.
- assert
Interval String - Specifies the number of seconds that assert state should be maintained in the absence of a refreshing assert message.
- assert
Rank Property Map - Assert rank defines the cost of a routing protocolrelative to other protocols. assert_rank blocks are documented below.
- bootstrap
Candidate Property Map - Configures candidate Bootstrap Router (candidate BSR) options. bootstrap_candidate blocks are documented below.
- candidate
Rp Property Map - Configures candidate Rendezvous Point (candidate RP) options. candidate_rp blocks are documented below.
- custom
Ssm List<Property Map>Prefixes - Configure Custom SSM Prefix custom_ssm_prefix blocks are documented below.
- data
Interval String - Configure the Data Interval.
- debug Boolean
- Enable debugging for this resource only.
- enable
State BooleanRefresh - Configure State Refresh
- gaia
Command StringSet Pim Id - hello
Interval String - Configure the Hello Interval.
- jp
Delay StringInterval - Configure the Random Delay Join/Prune Interval
- jp
Interval String - Configure the Join/Prune Interval (PIM-SM/SSM only).
- mode String
- Configure Dense Mode/Sparse Mode/SSM Mode
- register
Suppress StringInterval - Configure Register-Suppression Interval
- spt
Thresholds List<Property Map> - Configure SPT Threshold spt_threshold blocks are documented below.
- state
Refresh StringInterval - Configure State Refresh Interval
- state
Refresh StringTtl - Configure State Refresh TTL
- static
Rp Property Map - Configure Static Rendezvous Point static_rp blocks are documented below.
Supporting Types
GaiaCommandSetPimAssertRank, GaiaCommandSetPimAssertRankArgs
GaiaCommandSetPimBootstrapCandidate, GaiaCommandSetPimBootstrapCandidateArgs
- Enable bool
- Configures this router to be a candidate Bootstrap Router (candidate BSR).
- Local
Address string - Configures the local address to use for this candidate Bootstrap Router (candidate BSR).
- Priority string
- Configures the candidate Bootstrap Router (candidate BSR) priority.
- Enable bool
- Configures this router to be a candidate Bootstrap Router (candidate BSR).
- Local
Address string - Configures the local address to use for this candidate Bootstrap Router (candidate BSR).
- Priority string
- Configures the candidate Bootstrap Router (candidate BSR) priority.
- enable bool
- Configures this router to be a candidate Bootstrap Router (candidate BSR).
- local_
address string - Configures the local address to use for this candidate Bootstrap Router (candidate BSR).
- priority string
- Configures the candidate Bootstrap Router (candidate BSR) priority.
- enable Boolean
- Configures this router to be a candidate Bootstrap Router (candidate BSR).
- local
Address String - Configures the local address to use for this candidate Bootstrap Router (candidate BSR).
- priority String
- Configures the candidate Bootstrap Router (candidate BSR) priority.
- enable boolean
- Configures this router to be a candidate Bootstrap Router (candidate BSR).
- local
Address string - Configures the local address to use for this candidate Bootstrap Router (candidate BSR).
- priority string
- Configures the candidate Bootstrap Router (candidate BSR) priority.
- enable bool
- Configures this router to be a candidate Bootstrap Router (candidate BSR).
- local_
address str - Configures the local address to use for this candidate Bootstrap Router (candidate BSR).
- priority str
- Configures the candidate Bootstrap Router (candidate BSR) priority.
- enable Boolean
- Configures this router to be a candidate Bootstrap Router (candidate BSR).
- local
Address String - Configures the local address to use for this candidate Bootstrap Router (candidate BSR).
- priority String
- Configures the candidate Bootstrap Router (candidate BSR) priority.
GaiaCommandSetPimCandidateRp, GaiaCommandSetPimCandidateRpArgs
- Advertise
Interval double - Configure the Advertisement Interval
- Enable bool
- Configure a Candidate Rendezvous Point
- Local
Address string - Configure the Candidate RP Local Address.
- Multicast
Group GaiaCommand Set Pim Candidate Rp Multicast Group - Configure a Candidate RP Multicast Group. multicast_group blocks are documented below.
- Priority double
- Configure Candidate Rendezvous Point Priority.
- Advertise
Interval float64 - Configure the Advertisement Interval
- Enable bool
- Configure a Candidate Rendezvous Point
- Local
Address string - Configure the Candidate RP Local Address.
- Multicast
Group GaiaCommand Set Pim Candidate Rp Multicast Group - Configure a Candidate RP Multicast Group. multicast_group blocks are documented below.
- Priority float64
- Configure Candidate Rendezvous Point Priority.
- advertise_
interval number - Configure the Advertisement Interval
- enable bool
- Configure a Candidate Rendezvous Point
- local_
address string - Configure the Candidate RP Local Address.
- multicast_
group object - Configure a Candidate RP Multicast Group. multicast_group blocks are documented below.
- priority number
- Configure Candidate Rendezvous Point Priority.
- advertise
Interval Double - Configure the Advertisement Interval
- enable Boolean
- Configure a Candidate Rendezvous Point
- local
Address String - Configure the Candidate RP Local Address.
- multicast
Group GaiaCommand Set Pim Candidate Rp Multicast Group - Configure a Candidate RP Multicast Group. multicast_group blocks are documented below.
- priority Double
- Configure Candidate Rendezvous Point Priority.
- advertise
Interval number - Configure the Advertisement Interval
- enable boolean
- Configure a Candidate Rendezvous Point
- local
Address string - Configure the Candidate RP Local Address.
- multicast
Group GaiaCommand Set Pim Candidate Rp Multicast Group - Configure a Candidate RP Multicast Group. multicast_group blocks are documented below.
- priority number
- Configure Candidate Rendezvous Point Priority.
- advertise_
interval float - Configure the Advertisement Interval
- enable bool
- Configure a Candidate Rendezvous Point
- local_
address str - Configure the Candidate RP Local Address.
- multicast_
group GaiaCommand Set Pim Candidate Rp Multicast Group - Configure a Candidate RP Multicast Group. multicast_group blocks are documented below.
- priority float
- Configure Candidate Rendezvous Point Priority.
- advertise
Interval Number - Configure the Advertisement Interval
- enable Boolean
- Configure a Candidate Rendezvous Point
- local
Address String - Configure the Candidate RP Local Address.
- multicast
Group Property Map - Configure a Candidate RP Multicast Group. multicast_group blocks are documented below.
- priority Number
- Configure Candidate Rendezvous Point Priority.
GaiaCommandSetPimCandidateRpMulticastGroup, GaiaCommandSetPimCandidateRpMulticastGroupArgs
- Address string
- The multicast group prefix/mask, in CIDR notation.
- Address string
- The multicast group prefix/mask, in CIDR notation.
- address string
- The multicast group prefix/mask, in CIDR notation.
- address String
- The multicast group prefix/mask, in CIDR notation.
- address string
- The multicast group prefix/mask, in CIDR notation.
- address str
- The multicast group prefix/mask, in CIDR notation.
- address String
- The multicast group prefix/mask, in CIDR notation.
GaiaCommandSetPimCustomSsmPrefix, GaiaCommandSetPimCustomSsmPrefixArgs
- Address string
- The multicast group prefix/mask, in CIDR notation.
- Address string
- The multicast group prefix/mask, in CIDR notation.
- address string
- The multicast group prefix/mask, in CIDR notation.
- address String
- The multicast group prefix/mask, in CIDR notation.
- address string
- The multicast group prefix/mask, in CIDR notation.
- address str
- The multicast group prefix/mask, in CIDR notation.
- address String
- The multicast group prefix/mask, in CIDR notation.
GaiaCommandSetPimSptThreshold, GaiaCommandSetPimSptThresholdArgs
- Multicast
Group string - The multicast group prefix/mask, in CIDR notation.
- Threshold string
- The threshold for the multicast group.
- Multicast
Group string - The multicast group prefix/mask, in CIDR notation.
- Threshold string
- The threshold for the multicast group.
- multicast_
group string - The multicast group prefix/mask, in CIDR notation.
- threshold string
- The threshold for the multicast group.
- multicast
Group String - The multicast group prefix/mask, in CIDR notation.
- threshold String
- The threshold for the multicast group.
- multicast
Group string - The multicast group prefix/mask, in CIDR notation.
- threshold string
- The threshold for the multicast group.
- multicast_
group str - The multicast group prefix/mask, in CIDR notation.
- threshold str
- The threshold for the multicast group.
- multicast
Group String - The multicast group prefix/mask, in CIDR notation.
- threshold String
- The threshold for the multicast group.
GaiaCommandSetPimStaticRp, GaiaCommandSetPimStaticRpArgs
- Enable bool
- Configure a static Rendezvous Point (static RP).
- Multicast
Groups List<GaiaCommand Set Pim Static Rp Multicast Group> - Configure a Static RP Multicast Group. multicast_group blocks are documented below.
- Rp
Address string - Adds the given static Rendezvous Point (static RP).
- Enable bool
- Configure a static Rendezvous Point (static RP).
- Multicast
Groups []GaiaCommand Set Pim Static Rp Multicast Group - Configure a Static RP Multicast Group. multicast_group blocks are documented below.
- Rp
Address string - Adds the given static Rendezvous Point (static RP).
- enable bool
- Configure a static Rendezvous Point (static RP).
- multicast_
groups list(object) - Configure a Static RP Multicast Group. multicast_group blocks are documented below.
- rp_
address string - Adds the given static Rendezvous Point (static RP).
- enable Boolean
- Configure a static Rendezvous Point (static RP).
- multicast
Groups List<GaiaCommand Set Pim Static Rp Multicast Group> - Configure a Static RP Multicast Group. multicast_group blocks are documented below.
- rp
Address String - Adds the given static Rendezvous Point (static RP).
- enable boolean
- Configure a static Rendezvous Point (static RP).
- multicast
Groups GaiaCommand Set Pim Static Rp Multicast Group[] - Configure a Static RP Multicast Group. multicast_group blocks are documented below.
- rp
Address string - Adds the given static Rendezvous Point (static RP).
- enable bool
- Configure a static Rendezvous Point (static RP).
- multicast_
groups Sequence[GaiaCommand Set Pim Static Rp Multicast Group] - Configure a Static RP Multicast Group. multicast_group blocks are documented below.
- rp_
address str - Adds the given static Rendezvous Point (static RP).
- enable Boolean
- Configure a static Rendezvous Point (static RP).
- multicast
Groups List<Property Map> - Configure a Static RP Multicast Group. multicast_group blocks are documented below.
- rp
Address String - Adds the given static Rendezvous Point (static RP).
GaiaCommandSetPimStaticRpMulticastGroup, GaiaCommandSetPimStaticRpMulticastGroupArgs
- Address string
- The multicast group prefix/mask, in CIDR notation.
- Address string
- The multicast group prefix/mask, in CIDR notation.
- address string
- The multicast group prefix/mask, in CIDR notation.
- address String
- The multicast group prefix/mask, in CIDR notation.
- address string
- The multicast group prefix/mask, in CIDR notation.
- address str
- The multicast group prefix/mask, in CIDR notation.
- address String
- The multicast group prefix/mask, in CIDR notation.
Package Details
- Repository
- checkpoint checkpointsw/terraform-provider-checkpoint
- License
- Notes
- This Pulumi package is based on the
checkpointTerraform Provider.
published on Monday, Jun 15, 2026 by checkpointsw