1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. getClustersync
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.system.getClustersync

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: fortios:system/getClustersync:getClustersync
      arguments:
        # arguments dictionary

    The 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:

    DownIntfsBeforeSessSyncs List<Pulumiverse.Fortios.System.Outputs.GetClustersyncDownIntfsBeforeSessSync>
    List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_sync block is documented below.
    HbInterval int
    Heartbeat interval (1 - 10 sec).
    HbLostThreshold int
    Lost heartbeat threshold (1 - 10).
    Id string
    The provider-assigned unique ID for this managed resource.
    IkeHeartbeatInterval int
    IKE heartbeat interval (1 - 60 secs).
    IkeMonitor string
    Enable/disable IKE HA monitor.
    IkeMonitorInterval int
    IKE HA monitor interval (10 - 300 secs).
    IpsecTunnelSync string
    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.
    SecondaryAddIpsecRoutes string
    Enable/disable IKE route announcement on the backup unit.
    SessionSyncFilters List<Pulumiverse.Fortios.System.Outputs.GetClustersyncSessionSyncFilter>
    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_filter block is documented below.
    SlaveAddIkeRoutes string
    Enable/disable IKE route announcement on the backup unit.
    SyncId int
    Sync ID.
    Syncvds List<Pulumiverse.Fortios.System.Outputs.GetClustersyncSyncvd>
    Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvd block is documented below.
    Vdomparam string
    DownIntfsBeforeSessSyncs []GetClustersyncDownIntfsBeforeSessSync
    List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_sync block is documented below.
    HbInterval int
    Heartbeat interval (1 - 10 sec).
    HbLostThreshold int
    Lost heartbeat threshold (1 - 10).
    Id string
    The provider-assigned unique ID for this managed resource.
    IkeHeartbeatInterval int
    IKE heartbeat interval (1 - 60 secs).
    IkeMonitor string
    Enable/disable IKE HA monitor.
    IkeMonitorInterval int
    IKE HA monitor interval (10 - 300 secs).
    IpsecTunnelSync string
    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.
    SecondaryAddIpsecRoutes string
    Enable/disable IKE route announcement on the backup unit.
    SessionSyncFilters []GetClustersyncSessionSyncFilter
    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_filter block is documented below.
    SlaveAddIkeRoutes string
    Enable/disable IKE route announcement on the backup unit.
    SyncId int
    Sync ID.
    Syncvds []GetClustersyncSyncvd
    Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvd block is documented below.
    Vdomparam string
    downIntfsBeforeSessSyncs List<GetClustersyncDownIntfsBeforeSessSync>
    List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_sync block is documented below.
    hbInterval Integer
    Heartbeat interval (1 - 10 sec).
    hbLostThreshold Integer
    Lost heartbeat threshold (1 - 10).
    id String
    The provider-assigned unique ID for this managed resource.
    ikeHeartbeatInterval Integer
    IKE heartbeat interval (1 - 60 secs).
    ikeMonitor String
    Enable/disable IKE HA monitor.
    ikeMonitorInterval Integer
    IKE HA monitor interval (10 - 300 secs).
    ipsecTunnelSync String
    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.
    secondaryAddIpsecRoutes String
    Enable/disable IKE route announcement on the backup unit.
    sessionSyncFilters List<GetClustersyncSessionSyncFilter>
    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_filter block is documented below.
    slaveAddIkeRoutes String
    Enable/disable IKE route announcement on the backup unit.
    syncId Integer
    Sync ID.
    syncvds List<GetClustersyncSyncvd>
    Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvd block is documented below.
    vdomparam String
    downIntfsBeforeSessSyncs GetClustersyncDownIntfsBeforeSessSync[]
    List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_sync block is documented below.
    hbInterval number
    Heartbeat interval (1 - 10 sec).
    hbLostThreshold number
    Lost heartbeat threshold (1 - 10).
    id string
    The provider-assigned unique ID for this managed resource.
    ikeHeartbeatInterval number
    IKE heartbeat interval (1 - 60 secs).
    ikeMonitor string
    Enable/disable IKE HA monitor.
    ikeMonitorInterval number
    IKE HA monitor interval (10 - 300 secs).
    ipsecTunnelSync string
    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.
    secondaryAddIpsecRoutes string
    Enable/disable IKE route announcement on the backup unit.
    sessionSyncFilters GetClustersyncSessionSyncFilter[]
    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_filter block is documented below.
    slaveAddIkeRoutes string
    Enable/disable IKE route announcement on the backup unit.
    syncId number
    Sync ID.
    syncvds GetClustersyncSyncvd[]
    Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvd block is documented below.
    vdomparam string
    down_intfs_before_sess_syncs Sequence[GetClustersyncDownIntfsBeforeSessSync]
    List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_sync block is documented below.
    hb_interval int
    Heartbeat interval (1 - 10 sec).
    hb_lost_threshold int
    Lost heartbeat threshold (1 - 10).
    id str
    The provider-assigned unique ID for this managed resource.
    ike_heartbeat_interval int
    IKE heartbeat interval (1 - 60 secs).
    ike_monitor str
    Enable/disable IKE HA monitor.
    ike_monitor_interval int
    IKE HA monitor interval (10 - 300 secs).
    ipsec_tunnel_sync str
    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_ipsec_routes str
    Enable/disable IKE route announcement on the backup unit.
    session_sync_filters Sequence[GetClustersyncSessionSyncFilter]
    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_filter block is documented below.
    slave_add_ike_routes str
    Enable/disable IKE route announcement on the backup unit.
    sync_id int
    Sync ID.
    syncvds Sequence[GetClustersyncSyncvd]
    Sessions from these VDOMs are synchronized using this session synchronization configuration. The structure of syncvd block is documented below.
    vdomparam str
    downIntfsBeforeSessSyncs List<Property Map>
    List of interfaces to be turned down before session synchronization is complete. The structure of down_intfs_before_sess_sync block is documented below.
    hbInterval Number
    Heartbeat interval (1 - 10 sec).
    hbLostThreshold Number
    Lost heartbeat threshold (1 - 10).
    id String
    The provider-assigned unique ID for this managed resource.
    ikeHeartbeatInterval Number
    IKE heartbeat interval (1 - 60 secs).
    ikeMonitor String
    Enable/disable IKE HA monitor.
    ikeMonitorInterval Number
    IKE HA monitor interval (10 - 300 secs).
    ipsecTunnelSync String
    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.
    secondaryAddIpsecRoutes String
    Enable/disable IKE route announcement on the backup unit.
    sessionSyncFilters List<Property Map>
    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_filter block is documented below.
    slaveAddIkeRoutes String
    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 syncvd block 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.GetClustersyncSessionSyncFilterCustomService>
    Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_service block 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 []GetClustersyncSessionSyncFilterCustomService
    Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_service block 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<GetClustersyncSessionSyncFilterCustomService>
    Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_service block 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 GetClustersyncSessionSyncFilterCustomService[]
    Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_service block 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[GetClustersyncSessionSyncFilterCustomService]
    Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. The structure of custom_service block 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_service block 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

    DstPortRange string
    Custom service destination port range.
    Id int
    Custom service ID.
    SrcPortRange string
    Custom service source port range.
    DstPortRange string
    Custom service destination port range.
    Id int
    Custom service ID.
    SrcPortRange string
    Custom service source port range.
    dstPortRange String
    Custom service destination port range.
    id Integer
    Custom service ID.
    srcPortRange String
    Custom service source port range.
    dstPortRange string
    Custom service destination port range.
    id number
    Custom service ID.
    srcPortRange string
    Custom service source port range.
    dst_port_range str
    Custom service destination port range.
    id int
    Custom service ID.
    src_port_range str
    Custom service source port range.
    dstPortRange String
    Custom service destination port range.
    id Number
    Custom service ID.
    srcPortRange String
    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 fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse