1. Packages
  2. Packages
  3. Powerstore Provider
  4. API Docs
  5. getReplicationSession
Viewing docs for powerstore 1.3.0
published on Wednesday, Jun 24, 2026 by dell
Viewing docs for powerstore 1.3.0
published on Wednesday, Jun 24, 2026 by dell

    This datasource is used to query replication sessions from PowerStore array. The results can be used to monitor replication health, status, and session details for metro and async replication.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as powerstore from "@pulumi/powerstore";
    
    //Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
    //
    //Licensed under the Mozilla Public License Version 2.0 (the "License");
    //you may not use this file except in compliance with the License.
    //You may obtain a copy of the License at
    //
    //    http://mozilla.org/MPL/2.0/
    //
    //
    //Unless required by applicable law or agreed to in writing, software
    //distributed under the License is distributed on an "AS IS" BASIS,
    //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    //See the License for the specific language governing permissions and
    //limitations under the License.
    // Commands to run this tf file : terraform init && pulumi preview && pulumi up
    // This datasource reads replication session details from PowerStore array.
    // Example: Get all replication sessions
    const all = powerstore.getReplicationSession({});
    // Example: Get a specific replication session by ID
    const byId = powerstore.getReplicationSession({
        id: "replication-session-id-here",
    });
    
    import pulumi
    import pulumi_powerstore as powerstore
    
    #Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
    #
    #Licensed under the Mozilla Public License Version 2.0 (the "License");
    #you may not use this file except in compliance with the License.
    #You may obtain a copy of the License at
    #
    #    http://mozilla.org/MPL/2.0/
    #
    #
    #Unless required by applicable law or agreed to in writing, software
    #distributed under the License is distributed on an "AS IS" BASIS,
    #WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    #See the License for the specific language governing permissions and
    #limitations under the License.
    # Commands to run this tf file : terraform init && pulumi preview && pulumi up
    # This datasource reads replication session details from PowerStore array.
    # Example: Get all replication sessions
    all = powerstore.get_replication_session()
    # Example: Get a specific replication session by ID
    by_id = powerstore.get_replication_session(id="replication-session-id-here")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerstore/powerstore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
    		//
    		// Licensed under the Mozilla Public License Version 2.0 (the "License");
    		// you may not use this file except in compliance with the License.
    		// You may obtain a copy of the License at
    		//
    		//	http://mozilla.org/MPL/2.0/
    		//
    		// Unless required by applicable law or agreed to in writing, software
    		// distributed under the License is distributed on an "AS IS" BASIS,
    		// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    		// See the License for the specific language governing permissions and
    		// limitations under the License.
    		// Commands to run this tf file : terraform init && pulumi preview && pulumi up
    		// This datasource reads replication session details from PowerStore array.
    		// Example: Get all replication sessions
    		_, err := powerstore.GetReplicationSession(ctx, &powerstore.GetReplicationSessionArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		// Example: Get a specific replication session by ID
    		_, err = powerstore.GetReplicationSession(ctx, &powerstore.GetReplicationSessionArgs{
    			Id: pulumi.StringRef("replication-session-id-here"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Powerstore = Pulumi.Powerstore;
    
    return await Deployment.RunAsync(() => 
    {
        //Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
        //
        //Licensed under the Mozilla Public License Version 2.0 (the "License");
        //you may not use this file except in compliance with the License.
        //You may obtain a copy of the License at
        //
        //    http://mozilla.org/MPL/2.0/
        //
        //
        //Unless required by applicable law or agreed to in writing, software
        //distributed under the License is distributed on an "AS IS" BASIS,
        //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        //See the License for the specific language governing permissions and
        //limitations under the License.
        // Commands to run this tf file : terraform init && pulumi preview && pulumi up
        // This datasource reads replication session details from PowerStore array.
        // Example: Get all replication sessions
        var all = Powerstore.GetReplicationSession.Invoke();
    
        // Example: Get a specific replication session by ID
        var byId = Powerstore.GetReplicationSession.Invoke(new()
        {
            Id = "replication-session-id-here",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.powerstore.PowerstoreFunctions;
    import com.pulumi.powerstore.inputs.GetReplicationSessionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            //Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
            //
            //Licensed under the Mozilla Public License Version 2.0 (the "License");
            //you may not use this file except in compliance with the License.
            //You may obtain a copy of the License at
            //
            //    http://mozilla.org/MPL/2.0/
            //
            //
            //Unless required by applicable law or agreed to in writing, software
            //distributed under the License is distributed on an "AS IS" BASIS,
            //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            //See the License for the specific language governing permissions and
            //limitations under the License.
            // Commands to run this tf file : terraform init && pulumi preview && pulumi up
            // This datasource reads replication session details from PowerStore array.
            // Example: Get all replication sessions
            final var all = PowerstoreFunctions.getReplicationSession(GetReplicationSessionArgs.builder()
                .build());
    
            // Example: Get a specific replication session by ID
            final var byId = PowerstoreFunctions.getReplicationSession(GetReplicationSessionArgs.builder()
                .id("replication-session-id-here")
                .build());
    
        }
    }
    
    variables:
      # /*
      # Copyright (c) 2025 Dell Inc., or its subsidiaries. All Rights Reserved.
    
      # Licensed under the Mozilla Public License Version 2.0 (the "License");
      # you may not use this file except in compliance with the License.
      # You may obtain a copy of the License at
    
      #     http://mozilla.org/MPL/2.0/
    
    
      # Unless required by applicable law or agreed to in writing, software
      # distributed under the License is distributed on an "AS IS" BASIS,
      # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      # See the License for the specific language governing permissions and
      # limitations under the License.
      # */
    
    
      # Commands to run this tf file : terraform init && pulumi preview && pulumi up
      # This datasource reads replication session details from PowerStore array.
    
      # Example: Get all replication sessions
      all:
        fn::invoke:
          function: powerstore:getReplicationSession
          arguments: {}
      # Example: Get a specific replication session by ID
      byId:
        fn::invoke:
          function: powerstore:getReplicationSession
          arguments:
            id: replication-session-id-here
    
    Example coming soon!
    

    Using getReplicationSession

    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 getReplicationSession(args: GetReplicationSessionArgs, opts?: InvokeOptions): Promise<GetReplicationSessionResult>
    function getReplicationSessionOutput(args: GetReplicationSessionOutputArgs, opts?: InvokeOptions): Output<GetReplicationSessionResult>
    def get_replication_session(id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetReplicationSessionResult
    def get_replication_session_output(id: pulumi.Input[Optional[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetReplicationSessionResult]
    func GetReplicationSession(ctx *Context, args *GetReplicationSessionArgs, opts ...InvokeOption) (*GetReplicationSessionResult, error)
    func GetReplicationSessionOutput(ctx *Context, args *GetReplicationSessionOutputArgs, opts ...InvokeOption) GetReplicationSessionResultOutput

    > Note: This function is named GetReplicationSession in the Go SDK.

    public static class GetReplicationSession 
    {
        public static Task<GetReplicationSessionResult> InvokeAsync(GetReplicationSessionArgs args, InvokeOptions? opts = null)
        public static Output<GetReplicationSessionResult> Invoke(GetReplicationSessionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetReplicationSessionResult> getReplicationSession(GetReplicationSessionArgs args, InvokeOptions options)
    public static Output<GetReplicationSessionResult> getReplicationSession(GetReplicationSessionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: powerstore:index/getReplicationSession:getReplicationSession
      arguments:
        # arguments dictionary
    data "powerstore_getreplicationsession" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    Id string
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    id string
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    id String
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    id string
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    id str
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    id String
    Unique identifier of a specific replication session to query. If provided, only this session is returned.

    getReplicationSession Result

    The following output properties are available:

    Id string
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    ReplicationSessions List<GetReplicationSessionReplicationSession>
    List of replication sessions matching the query.
    Id string
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    ReplicationSessions []GetReplicationSessionReplicationSession
    List of replication sessions matching the query.
    id string
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    replication_sessions list(object)
    List of replication sessions matching the query.
    id String
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    replicationSessions List<GetReplicationSessionReplicationSession>
    List of replication sessions matching the query.
    id string
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    replicationSessions GetReplicationSessionReplicationSession[]
    List of replication sessions matching the query.
    id str
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    replication_sessions Sequence[GetReplicationSessionReplicationSession]
    List of replication sessions matching the query.
    id String
    Unique identifier of a specific replication session to query. If provided, only this session is returned.
    replicationSessions List<Property Map>
    List of replication sessions matching the query.

    Supporting Types

    GetReplicationSessionReplicationSession

    DataTransferState string
    Current data transfer state.
    FailoverTestInProgress bool
    Whether a test failover is in progress.
    Id string
    Unique identifier of the replication session.
    LastSyncDuration double
    Elapsed time of the last synchronization in milliseconds.
    LastSyncTimestamp string
    Time of last successful synchronization.
    LocalResourceId string
    Unique identifier of the local storage resource.
    ProgressPercentage double
    Progress of the current replication operation.
    RemoteResourceId string
    Unique identifier of the remote storage resource.
    RemoteSystemId string
    Unique identifier of the remote system.
    ReplicationRuleId string
    Associated replication rule instance ID.
    ResourceType string
    Type of the storage resource.
    ResourceTypeL10n string
    Localized resource type string.
    Role string
    Role of the replication session.
    RoleL10n string
    Localized role string.
    State string
    Current state of the replication session.
    StateL10n string
    Localized state string.
    Type string
    Replication session type (e.g., MetroActiveActive).
    TypeL10n string
    Localized type string.
    DataTransferState string
    Current data transfer state.
    FailoverTestInProgress bool
    Whether a test failover is in progress.
    Id string
    Unique identifier of the replication session.
    LastSyncDuration float64
    Elapsed time of the last synchronization in milliseconds.
    LastSyncTimestamp string
    Time of last successful synchronization.
    LocalResourceId string
    Unique identifier of the local storage resource.
    ProgressPercentage float64
    Progress of the current replication operation.
    RemoteResourceId string
    Unique identifier of the remote storage resource.
    RemoteSystemId string
    Unique identifier of the remote system.
    ReplicationRuleId string
    Associated replication rule instance ID.
    ResourceType string
    Type of the storage resource.
    ResourceTypeL10n string
    Localized resource type string.
    Role string
    Role of the replication session.
    RoleL10n string
    Localized role string.
    State string
    Current state of the replication session.
    StateL10n string
    Localized state string.
    Type string
    Replication session type (e.g., MetroActiveActive).
    TypeL10n string
    Localized type string.
    data_transfer_state string
    Current data transfer state.
    failover_test_in_progress bool
    Whether a test failover is in progress.
    id string
    Unique identifier of the replication session.
    last_sync_duration number
    Elapsed time of the last synchronization in milliseconds.
    last_sync_timestamp string
    Time of last successful synchronization.
    local_resource_id string
    Unique identifier of the local storage resource.
    progress_percentage number
    Progress of the current replication operation.
    remote_resource_id string
    Unique identifier of the remote storage resource.
    remote_system_id string
    Unique identifier of the remote system.
    replication_rule_id string
    Associated replication rule instance ID.
    resource_type string
    Type of the storage resource.
    resource_type_l10n string
    Localized resource type string.
    role string
    Role of the replication session.
    role_l10n string
    Localized role string.
    state string
    Current state of the replication session.
    state_l10n string
    Localized state string.
    type string
    Replication session type (e.g., MetroActiveActive).
    type_l10n string
    Localized type string.
    dataTransferState String
    Current data transfer state.
    failoverTestInProgress Boolean
    Whether a test failover is in progress.
    id String
    Unique identifier of the replication session.
    lastSyncDuration Double
    Elapsed time of the last synchronization in milliseconds.
    lastSyncTimestamp String
    Time of last successful synchronization.
    localResourceId String
    Unique identifier of the local storage resource.
    progressPercentage Double
    Progress of the current replication operation.
    remoteResourceId String
    Unique identifier of the remote storage resource.
    remoteSystemId String
    Unique identifier of the remote system.
    replicationRuleId String
    Associated replication rule instance ID.
    resourceType String
    Type of the storage resource.
    resourceTypeL10n String
    Localized resource type string.
    role String
    Role of the replication session.
    roleL10n String
    Localized role string.
    state String
    Current state of the replication session.
    stateL10n String
    Localized state string.
    type String
    Replication session type (e.g., MetroActiveActive).
    typeL10n String
    Localized type string.
    dataTransferState string
    Current data transfer state.
    failoverTestInProgress boolean
    Whether a test failover is in progress.
    id string
    Unique identifier of the replication session.
    lastSyncDuration number
    Elapsed time of the last synchronization in milliseconds.
    lastSyncTimestamp string
    Time of last successful synchronization.
    localResourceId string
    Unique identifier of the local storage resource.
    progressPercentage number
    Progress of the current replication operation.
    remoteResourceId string
    Unique identifier of the remote storage resource.
    remoteSystemId string
    Unique identifier of the remote system.
    replicationRuleId string
    Associated replication rule instance ID.
    resourceType string
    Type of the storage resource.
    resourceTypeL10n string
    Localized resource type string.
    role string
    Role of the replication session.
    roleL10n string
    Localized role string.
    state string
    Current state of the replication session.
    stateL10n string
    Localized state string.
    type string
    Replication session type (e.g., MetroActiveActive).
    typeL10n string
    Localized type string.
    data_transfer_state str
    Current data transfer state.
    failover_test_in_progress bool
    Whether a test failover is in progress.
    id str
    Unique identifier of the replication session.
    last_sync_duration float
    Elapsed time of the last synchronization in milliseconds.
    last_sync_timestamp str
    Time of last successful synchronization.
    local_resource_id str
    Unique identifier of the local storage resource.
    progress_percentage float
    Progress of the current replication operation.
    remote_resource_id str
    Unique identifier of the remote storage resource.
    remote_system_id str
    Unique identifier of the remote system.
    replication_rule_id str
    Associated replication rule instance ID.
    resource_type str
    Type of the storage resource.
    resource_type_l10n str
    Localized resource type string.
    role str
    Role of the replication session.
    role_l10n str
    Localized role string.
    state str
    Current state of the replication session.
    state_l10n str
    Localized state string.
    type str
    Replication session type (e.g., MetroActiveActive).
    type_l10n str
    Localized type string.
    dataTransferState String
    Current data transfer state.
    failoverTestInProgress Boolean
    Whether a test failover is in progress.
    id String
    Unique identifier of the replication session.
    lastSyncDuration Number
    Elapsed time of the last synchronization in milliseconds.
    lastSyncTimestamp String
    Time of last successful synchronization.
    localResourceId String
    Unique identifier of the local storage resource.
    progressPercentage Number
    Progress of the current replication operation.
    remoteResourceId String
    Unique identifier of the remote storage resource.
    remoteSystemId String
    Unique identifier of the remote system.
    replicationRuleId String
    Associated replication rule instance ID.
    resourceType String
    Type of the storage resource.
    resourceTypeL10n String
    Localized resource type string.
    role String
    Role of the replication session.
    roleL10n String
    Localized role string.
    state String
    Current state of the replication session.
    stateL10n String
    Localized state string.
    type String
    Replication session type (e.g., MetroActiveActive).
    typeL10n String
    Localized type string.

    Package Details

    Repository
    powerstore dell/terraform-provider-powerstore
    License
    Notes
    This Pulumi package is based on the powerstore Terraform Provider.
    Viewing docs for powerstore 1.3.0
    published on Wednesday, Jun 24, 2026 by dell

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial