1. Packages
  2. Nutanix
  3. API Docs
  4. getKarbonClusterSsh
Nutanix v0.11.0 published on Monday, Nov 24, 2025 by Piers Karsenbarg
nutanix logo
Nutanix v0.11.0 published on Monday, Nov 24, 2025 by Piers Karsenbarg

    Describes the SSH config from a Karbon Cluster

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pierskarsenbarg/nutanix";
    
    // Get ssh credentials by cluster UUID
    const sshbyid = nutanix.getKarbonClusterSsh({
        karbonClusterId: "<YOUR-CLUSTER-ID>",
    });
    // Get ssh credentials by cluster name
    const sshbyname = nutanix.getKarbonClusterSsh({
        karbonClusterName: "<YOUR-CLUSTER-NAME>",
    });
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    # Get ssh credentials by cluster UUID
    sshbyid = nutanix.get_karbon_cluster_ssh(karbon_cluster_id="<YOUR-CLUSTER-ID>")
    # Get ssh credentials by cluster name
    sshbyname = nutanix.get_karbon_cluster_ssh(karbon_cluster_name="<YOUR-CLUSTER-NAME>")
    
    package main
    
    import (
    	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Get ssh credentials by cluster UUID
    		_, err := nutanix.GetKarbonClusterSsh(ctx, &nutanix.GetKarbonClusterSshArgs{
    			KarbonClusterId: pulumi.StringRef("<YOUR-CLUSTER-ID>"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		// Get ssh credentials by cluster name
    		_, err = nutanix.GetKarbonClusterSsh(ctx, &nutanix.GetKarbonClusterSshArgs{
    			KarbonClusterName: pulumi.StringRef("<YOUR-CLUSTER-NAME>"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = Pulumi.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        // Get ssh credentials by cluster UUID
        var sshbyid = Nutanix.GetKarbonClusterSsh.Invoke(new()
        {
            KarbonClusterId = "<YOUR-CLUSTER-ID>",
        });
    
        // Get ssh credentials by cluster name
        var sshbyname = Nutanix.GetKarbonClusterSsh.Invoke(new()
        {
            KarbonClusterName = "<YOUR-CLUSTER-NAME>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.NutanixFunctions;
    import com.pulumi.nutanix.inputs.GetKarbonClusterSshArgs;
    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) {
            // Get ssh credentials by cluster UUID
            final var sshbyid = NutanixFunctions.getKarbonClusterSsh(GetKarbonClusterSshArgs.builder()
                .karbonClusterId("<YOUR-CLUSTER-ID>")
                .build());
    
            // Get ssh credentials by cluster name
            final var sshbyname = NutanixFunctions.getKarbonClusterSsh(GetKarbonClusterSshArgs.builder()
                .karbonClusterName("<YOUR-CLUSTER-NAME>")
                .build());
    
        }
    }
    
    variables:
      # Get ssh credentials by cluster UUID
      sshbyid:
        fn::invoke:
          function: nutanix:getKarbonClusterSsh
          arguments:
            karbonClusterId: <YOUR-CLUSTER-ID>
      # Get ssh credentials by cluster name
      sshbyname:
        fn::invoke:
          function: nutanix:getKarbonClusterSsh
          arguments:
            karbonClusterName: <YOUR-CLUSTER-NAME>
    

    Using getKarbonClusterSsh

    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 getKarbonClusterSsh(args: GetKarbonClusterSshArgs, opts?: InvokeOptions): Promise<GetKarbonClusterSshResult>
    function getKarbonClusterSshOutput(args: GetKarbonClusterSshOutputArgs, opts?: InvokeOptions): Output<GetKarbonClusterSshResult>
    def get_karbon_cluster_ssh(karbon_cluster_id: Optional[str] = None,
                               karbon_cluster_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetKarbonClusterSshResult
    def get_karbon_cluster_ssh_output(karbon_cluster_id: Optional[pulumi.Input[str]] = None,
                               karbon_cluster_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetKarbonClusterSshResult]
    func GetKarbonClusterSsh(ctx *Context, args *GetKarbonClusterSshArgs, opts ...InvokeOption) (*GetKarbonClusterSshResult, error)
    func GetKarbonClusterSshOutput(ctx *Context, args *GetKarbonClusterSshOutputArgs, opts ...InvokeOption) GetKarbonClusterSshResultOutput

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

    public static class GetKarbonClusterSsh 
    {
        public static Task<GetKarbonClusterSshResult> InvokeAsync(GetKarbonClusterSshArgs args, InvokeOptions? opts = null)
        public static Output<GetKarbonClusterSshResult> Invoke(GetKarbonClusterSshInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKarbonClusterSshResult> getKarbonClusterSsh(GetKarbonClusterSshArgs args, InvokeOptions options)
    public static Output<GetKarbonClusterSshResult> getKarbonClusterSsh(GetKarbonClusterSshArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nutanix:index/getKarbonClusterSsh:getKarbonClusterSsh
      arguments:
        # arguments dictionary

    The following arguments are supported:

    KarbonClusterId string
    Represents karbon cluster uuid
    KarbonClusterName string
    Represents the name of karbon cluster
    KarbonClusterId string
    Represents karbon cluster uuid
    KarbonClusterName string
    Represents the name of karbon cluster
    karbonClusterId String
    Represents karbon cluster uuid
    karbonClusterName String
    Represents the name of karbon cluster
    karbonClusterId string
    Represents karbon cluster uuid
    karbonClusterName string
    Represents the name of karbon cluster
    karbon_cluster_id str
    Represents karbon cluster uuid
    karbon_cluster_name str
    Represents the name of karbon cluster
    karbonClusterId String
    Represents karbon cluster uuid
    karbonClusterName String
    Represents the name of karbon cluster

    getKarbonClusterSsh Result

    The following output properties are available:

    Certificate string
    Certificate of the user for SSH access.
    ExpiryTime string
    Timestamp of certificate expiry in the ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateKey string
    The private key of the user for SSH access.
    Username string
    The username for which credentials are returned.
    KarbonClusterId string
    KarbonClusterName string
    Certificate string
    Certificate of the user for SSH access.
    ExpiryTime string
    Timestamp of certificate expiry in the ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateKey string
    The private key of the user for SSH access.
    Username string
    The username for which credentials are returned.
    KarbonClusterId string
    KarbonClusterName string
    certificate String
    Certificate of the user for SSH access.
    expiryTime String
    Timestamp of certificate expiry in the ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
    id String
    The provider-assigned unique ID for this managed resource.
    privateKey String
    The private key of the user for SSH access.
    username String
    The username for which credentials are returned.
    karbonClusterId String
    karbonClusterName String
    certificate string
    Certificate of the user for SSH access.
    expiryTime string
    Timestamp of certificate expiry in the ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
    id string
    The provider-assigned unique ID for this managed resource.
    privateKey string
    The private key of the user for SSH access.
    username string
    The username for which credentials are returned.
    karbonClusterId string
    karbonClusterName string
    certificate str
    Certificate of the user for SSH access.
    expiry_time str
    Timestamp of certificate expiry in the ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
    id str
    The provider-assigned unique ID for this managed resource.
    private_key str
    The private key of the user for SSH access.
    username str
    The username for which credentials are returned.
    karbon_cluster_id str
    karbon_cluster_name str
    certificate String
    Certificate of the user for SSH access.
    expiryTime String
    Timestamp of certificate expiry in the ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ).
    id String
    The provider-assigned unique ID for this managed resource.
    privateKey String
    The private key of the user for SSH access.
    username String
    The username for which credentials are returned.
    karbonClusterId String
    karbonClusterName String

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.11.0 published on Monday, Nov 24, 2025 by Piers Karsenbarg
      Meet Neo: Your AI Platform Teammate