Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
fortios.system.getClustersync
Explore with Pulumi AI
Use this data source to get information on an fortios system clustersync
Using getClustersync
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getClustersync(args: GetClustersyncArgs, opts?: InvokeOptions): Promise<GetClustersyncResult>
function getClustersyncOutput(args: GetClustersyncOutputArgs, opts?: InvokeOptions): Output<GetClustersyncResult>def get_clustersync(sync_id: Optional[int] = None,
                    vdomparam: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetClustersyncResult
def get_clustersync_output(sync_id: Optional[pulumi.Input[int]] = None,
                    vdomparam: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetClustersyncResult]func LookupClustersync(ctx *Context, args *LookupClustersyncArgs, opts ...InvokeOption) (*LookupClustersyncResult, error)
func LookupClustersyncOutput(ctx *Context, args *LookupClustersyncOutputArgs, opts ...InvokeOption) LookupClustersyncResultOutput> Note: This function is named LookupClustersync in the Go SDK.
public static class GetClustersync 
{
    public static Task<GetClustersyncResult> InvokeAsync(GetClustersyncArgs args, InvokeOptions? opts = null)
    public static Output<GetClustersyncResult> Invoke(GetClustersyncInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetClustersyncResult> getClustersync(GetClustersyncArgs args, InvokeOptions options)
public static Output<GetClustersyncResult> getClustersync(GetClustersyncArgs args, InvokeOptions options)
fn::invoke:
  function: fortios:system/getClustersync:getClustersync
  arguments:
    # arguments dictionaryThe following arguments are supported:
- SyncId int
- Specify the sync_id of the desired system clustersync.
- Vdomparam string
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- SyncId int
- Specify the sync_id of the desired system clustersync.
- Vdomparam string
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- syncId Integer
- Specify the sync_id of the desired system clustersync.
- vdomparam String
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- syncId number
- Specify the sync_id of the desired system clustersync.
- vdomparam string
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- sync_id int
- Specify the sync_id of the desired system clustersync.
- vdomparam str
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- syncId Number
- Specify the sync_id of the desired system clustersync.
- vdomparam String
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
getClustersync Result
The following output properties are available:
- DownIntfs List<Pulumiverse.Before Sess Syncs Fortios. System. Outputs. Get Clustersync Down Intfs Before Sess Sync> 
- List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_syncblock is documented below.
- HbInterval int
- Heartbeat interval (1 - 10 sec).
- HbLost intThreshold 
- Lost heartbeat threshold (1 - 10).
- Id string
- The provider-assigned unique ID for this managed resource.
- IkeHeartbeat intInterval 
- IKE heartbeat interval (1 - 60 secs).
- IkeMonitor string
- Enable/disable IKE HA monitor.
- IkeMonitor intInterval 
- IKE HA monitor interval (10 - 300 secs).
- IpsecTunnel stringSync 
- Enable/disable IPsec tunnel synchronization.
- Peerip string
- IP address of the interface on the peer unit that is used for the session synchronization link.
- Peervd string
- VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd.
- SecondaryAdd stringIpsec Routes 
- Enable/disable IKE route announcement on the backup unit.
- SessionSync List<Pulumiverse.Filters Fortios. System. Outputs. Get Clustersync Session Sync Filter> 
- Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. The structure of session_sync_filterblock is documented below.
- SlaveAdd stringIke Routes 
- Enable/disable IKE route announcement on the backup unit.
- SyncId int
- Sync ID.
- Syncvds
List<Pulumiverse.Fortios. System. Outputs. Get Clustersync Syncvd> 
- Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvdblock is documented below.
- Vdomparam string
- DownIntfs []GetBefore Sess Syncs Clustersync Down Intfs Before Sess Sync 
- List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_syncblock is documented below.
- HbInterval int
- Heartbeat interval (1 - 10 sec).
- HbLost intThreshold 
- Lost heartbeat threshold (1 - 10).
- Id string
- The provider-assigned unique ID for this managed resource.
- IkeHeartbeat intInterval 
- IKE heartbeat interval (1 - 60 secs).
- IkeMonitor string
- Enable/disable IKE HA monitor.
- IkeMonitor intInterval 
- IKE HA monitor interval (10 - 300 secs).
- IpsecTunnel stringSync 
- Enable/disable IPsec tunnel synchronization.
- Peerip string
- IP address of the interface on the peer unit that is used for the session synchronization link.
- Peervd string
- VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd.
- SecondaryAdd stringIpsec Routes 
- Enable/disable IKE route announcement on the backup unit.
- SessionSync []GetFilters Clustersync Session Sync Filter 
- Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. The structure of session_sync_filterblock is documented below.
- SlaveAdd stringIke Routes 
- Enable/disable IKE route announcement on the backup unit.
- SyncId int
- Sync ID.
- Syncvds
[]GetClustersync Syncvd 
- Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvdblock is documented below.
- Vdomparam string
- downIntfs List<GetBefore Sess Syncs Clustersync Down Intfs Before Sess Sync> 
- List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_syncblock is documented below.
- hbInterval Integer
- Heartbeat interval (1 - 10 sec).
- hbLost IntegerThreshold 
- Lost heartbeat threshold (1 - 10).
- id String
- The provider-assigned unique ID for this managed resource.
- ikeHeartbeat IntegerInterval 
- IKE heartbeat interval (1 - 60 secs).
- ikeMonitor String
- Enable/disable IKE HA monitor.
- ikeMonitor IntegerInterval 
- IKE HA monitor interval (10 - 300 secs).
- ipsecTunnel StringSync 
- Enable/disable IPsec tunnel synchronization.
- peerip String
- IP address of the interface on the peer unit that is used for the session synchronization link.
- peervd String
- VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd.
- secondaryAdd StringIpsec Routes 
- Enable/disable IKE route announcement on the backup unit.
- sessionSync List<GetFilters Clustersync Session Sync Filter> 
- Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. The structure of session_sync_filterblock is documented below.
- slaveAdd StringIke Routes 
- Enable/disable IKE route announcement on the backup unit.
- syncId Integer
- Sync ID.
- syncvds
List<GetClustersync Syncvd> 
- Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvdblock is documented below.
- vdomparam String
- downIntfs GetBefore Sess Syncs Clustersync Down Intfs Before Sess Sync[] 
- List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_syncblock is documented below.
- hbInterval number
- Heartbeat interval (1 - 10 sec).
- hbLost numberThreshold 
- Lost heartbeat threshold (1 - 10).
- id string
- The provider-assigned unique ID for this managed resource.
- ikeHeartbeat numberInterval 
- IKE heartbeat interval (1 - 60 secs).
- ikeMonitor string
- Enable/disable IKE HA monitor.
- ikeMonitor numberInterval 
- IKE HA monitor interval (10 - 300 secs).
- ipsecTunnel stringSync 
- Enable/disable IPsec tunnel synchronization.
- peerip string
- IP address of the interface on the peer unit that is used for the session synchronization link.
- peervd string
- VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd.
- secondaryAdd stringIpsec Routes 
- Enable/disable IKE route announcement on the backup unit.
- sessionSync GetFilters Clustersync Session Sync Filter[] 
- Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. The structure of session_sync_filterblock is documented below.
- slaveAdd stringIke Routes 
- Enable/disable IKE route announcement on the backup unit.
- syncId number
- Sync ID.
- syncvds
GetClustersync Syncvd[] 
- Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvdblock is documented below.
- vdomparam string
- down_intfs_ Sequence[Getbefore_ sess_ syncs Clustersync Down Intfs Before Sess Sync] 
- List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_syncblock is documented below.
- hb_interval int
- Heartbeat interval (1 - 10 sec).
- hb_lost_ intthreshold 
- Lost heartbeat threshold (1 - 10).
- id str
- The provider-assigned unique ID for this managed resource.
- ike_heartbeat_ intinterval 
- IKE heartbeat interval (1 - 60 secs).
- ike_monitor str
- Enable/disable IKE HA monitor.
- ike_monitor_ intinterval 
- IKE HA monitor interval (10 - 300 secs).
- ipsec_tunnel_ strsync 
- Enable/disable IPsec tunnel synchronization.
- peerip str
- IP address of the interface on the peer unit that is used for the session synchronization link.
- peervd str
- VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd.
- secondary_add_ stripsec_ routes 
- Enable/disable IKE route announcement on the backup unit.
- session_sync_ Sequence[Getfilters Clustersync Session Sync Filter] 
- Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. The structure of session_sync_filterblock is documented below.
- slave_add_ strike_ routes 
- Enable/disable IKE route announcement on the backup unit.
- sync_id int
- Sync ID.
- syncvds
Sequence[GetClustersync Syncvd] 
- Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvdblock is documented below.
- vdomparam str
- downIntfs List<Property Map>Before Sess Syncs 
- List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_syncblock is documented below.
- hbInterval Number
- Heartbeat interval (1 - 10 sec).
- hbLost NumberThreshold 
- Lost heartbeat threshold (1 - 10).
- id String
- The provider-assigned unique ID for this managed resource.
- ikeHeartbeat NumberInterval 
- IKE heartbeat interval (1 - 60 secs).
- ikeMonitor String
- Enable/disable IKE HA monitor.
- ikeMonitor NumberInterval 
- IKE HA monitor interval (10 - 300 secs).
- ipsecTunnel StringSync 
- Enable/disable IPsec tunnel synchronization.
- peerip String
- IP address of the interface on the peer unit that is used for the session synchronization link.
- peervd String
- VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd.
- secondaryAdd StringIpsec Routes 
- Enable/disable IKE route announcement on the backup unit.
- sessionSync List<Property Map>Filters 
- Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. The structure of session_sync_filterblock is documented below.
- slaveAdd StringIke Routes 
- Enable/disable IKE route announcement on the backup unit.
- syncId Number
- Sync ID.
- syncvds List<Property Map>
- Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvdblock is documented below.
- vdomparam String
Supporting Types
GetClustersyncDownIntfsBeforeSessSync      
- Name string
- Interface name.
- Name string
- Interface name.
- name String
- Interface name.
- name string
- Interface name.
- name str
- Interface name.
- name String
- Interface name.
GetClustersyncSessionSyncFilter    
- CustomServices List<Pulumiverse.Fortios. System. Inputs. Get Clustersync Session Sync Filter Custom Service> 
- Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_serviceblock is documented below.
- Dstaddr string
- Only sessions to this IPv4 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- Dstaddr6 string
- Only sessions to this IPv6 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- Dstintf string
- Only sessions to this interface are synchronized. You can only enter one interface name. To synchronize sessions to multiple destination interfaces, add multiple filters.
- Srcaddr string
- Only sessions from this IPv4 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- Srcaddr6 string
- Only sessions from this IPv6 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- Srcintf string
- Only sessions from this interface are synchronized. You can only enter one interface name. To synchronize sessions for multiple source interfaces, add multiple filters.
- CustomServices []GetClustersync Session Sync Filter Custom Service 
- Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_serviceblock is documented below.
- Dstaddr string
- Only sessions to this IPv4 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- Dstaddr6 string
- Only sessions to this IPv6 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- Dstintf string
- Only sessions to this interface are synchronized. You can only enter one interface name. To synchronize sessions to multiple destination interfaces, add multiple filters.
- Srcaddr string
- Only sessions from this IPv4 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- Srcaddr6 string
- Only sessions from this IPv6 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- Srcintf string
- Only sessions from this interface are synchronized. You can only enter one interface name. To synchronize sessions for multiple source interfaces, add multiple filters.
- customServices List<GetClustersync Session Sync Filter Custom Service> 
- Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_serviceblock is documented below.
- dstaddr String
- Only sessions to this IPv4 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- dstaddr6 String
- Only sessions to this IPv6 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- dstintf String
- Only sessions to this interface are synchronized. You can only enter one interface name. To synchronize sessions to multiple destination interfaces, add multiple filters.
- srcaddr String
- Only sessions from this IPv4 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- srcaddr6 String
- Only sessions from this IPv6 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- srcintf String
- Only sessions from this interface are synchronized. You can only enter one interface name. To synchronize sessions for multiple source interfaces, add multiple filters.
- customServices GetClustersync Session Sync Filter Custom Service[] 
- Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_serviceblock is documented below.
- dstaddr string
- Only sessions to this IPv4 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- dstaddr6 string
- Only sessions to this IPv6 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- dstintf string
- Only sessions to this interface are synchronized. You can only enter one interface name. To synchronize sessions to multiple destination interfaces, add multiple filters.
- srcaddr string
- Only sessions from this IPv4 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- srcaddr6 string
- Only sessions from this IPv6 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- srcintf string
- Only sessions from this interface are synchronized. You can only enter one interface name. To synchronize sessions for multiple source interfaces, add multiple filters.
- custom_services Sequence[GetClustersync Session Sync Filter Custom Service] 
- Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_serviceblock is documented below.
- dstaddr str
- Only sessions to this IPv4 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- dstaddr6 str
- Only sessions to this IPv6 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- dstintf str
- Only sessions to this interface are synchronized. You can only enter one interface name. To synchronize sessions to multiple destination interfaces, add multiple filters.
- srcaddr str
- Only sessions from this IPv4 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- srcaddr6 str
- Only sessions from this IPv6 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- srcintf str
- Only sessions from this interface are synchronized. You can only enter one interface name. To synchronize sessions for multiple source interfaces, add multiple filters.
- customServices List<Property Map>
- Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_serviceblock is documented below.
- dstaddr String
- Only sessions to this IPv4 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- dstaddr6 String
- Only sessions to this IPv6 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
- dstintf String
- Only sessions to this interface are synchronized. You can only enter one interface name. To synchronize sessions to multiple destination interfaces, add multiple filters.
- srcaddr String
- Only sessions from this IPv4 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- srcaddr6 String
- Only sessions from this IPv6 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
- srcintf String
- Only sessions from this interface are synchronized. You can only enter one interface name. To synchronize sessions for multiple source interfaces, add multiple filters.
GetClustersyncSessionSyncFilterCustomService      
- DstPort stringRange 
- Custom service destination port range.
- Id int
- Custom service ID.
- SrcPort stringRange 
- Custom service source port range.
- DstPort stringRange 
- Custom service destination port range.
- Id int
- Custom service ID.
- SrcPort stringRange 
- Custom service source port range.
- dstPort StringRange 
- Custom service destination port range.
- id Integer
- Custom service ID.
- srcPort StringRange 
- Custom service source port range.
- dstPort stringRange 
- Custom service destination port range.
- id number
- Custom service ID.
- srcPort stringRange 
- Custom service source port range.
- dst_port_ strrange 
- Custom service destination port range.
- id int
- Custom service ID.
- src_port_ strrange 
- Custom service source port range.
- dstPort StringRange 
- Custom service destination port range.
- id Number
- Custom service ID.
- srcPort StringRange 
- Custom service source port range.
GetClustersyncSyncvd  
- Name string
- Interface name.
- Name string
- Interface name.
- name String
- Interface name.
- name string
- Interface name.
- name str
- Interface name.
- name String
- Interface name.
Package Details
- Repository
- fortios pulumiverse/pulumi-fortios
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the fortiosTerraform Provider.
