1. Packages
  2. Powerscale Provider
  3. API Docs
  4. ClusterIdentity
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

powerscale.ClusterIdentity

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

    This resource is used to manage the Cluster Identity settings of PowerScale Array. We can Create, Update and Delete the Cluster Identity using this resource. We can also import the existing Cluster Identity settings from PowerScale array.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.powerscale.ClusterIdentity;
    import com.pulumi.powerscale.ClusterIdentityArgs;
    import com.pulumi.powerscale.inputs.ClusterIdentityLogonArgs;
    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) {
            // PowerScale Cluster identity Settings allow you to change the settings of identity
            var exampleIdentitySettings = new ClusterIdentity("exampleIdentitySettings", ClusterIdentityArgs.builder()
                .description("cluster1 description")
                .logon(ClusterIdentityLogonArgs.builder()
                    .motd("motd")
                    .motd_header("motd header")
                    .build())
                .build());
    
        }
    }
    
    resources:
      # PowerScale Cluster identity Settings allow you to change the settings of identity
      exampleIdentitySettings:
        type: powerscale:ClusterIdentity
        properties:
          # The description of the cluster.
          description: cluster1 description
          # The information displayed when a user logs in to the cluster.
          logon:
            motd: motd
            motd_header: motd header
    

    Create ClusterIdentity Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClusterIdentity(name: string, args?: ClusterIdentityArgs, opts?: CustomResourceOptions);
    @overload
    def ClusterIdentity(resource_name: str,
                        args: Optional[ClusterIdentityArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ClusterIdentity(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        logon: Optional[ClusterIdentityLogonArgs] = None,
                        name: Optional[str] = None)
    func NewClusterIdentity(ctx *Context, name string, args *ClusterIdentityArgs, opts ...ResourceOption) (*ClusterIdentity, error)
    public ClusterIdentity(string name, ClusterIdentityArgs? args = null, CustomResourceOptions? opts = null)
    public ClusterIdentity(String name, ClusterIdentityArgs args)
    public ClusterIdentity(String name, ClusterIdentityArgs args, CustomResourceOptions options)
    
    type: powerscale:ClusterIdentity
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ClusterIdentityArgs
    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 ClusterIdentityArgs
    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 ClusterIdentityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterIdentityArgs
    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 clusterIdentityResource = new Powerscale.ClusterIdentity("clusterIdentityResource", new()
    {
        Description = "string",
        Logon = new Powerscale.Inputs.ClusterIdentityLogonArgs
        {
            Motd = "string",
            MotdHeader = "string",
        },
        Name = "string",
    });
    
    example, err := powerscale.NewClusterIdentity(ctx, "clusterIdentityResource", &powerscale.ClusterIdentityArgs{
    	Description: pulumi.String("string"),
    	Logon: &powerscale.ClusterIdentityLogonArgs{
    		Motd:       pulumi.String("string"),
    		MotdHeader: pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    })
    
    var clusterIdentityResource = new ClusterIdentity("clusterIdentityResource", ClusterIdentityArgs.builder()
        .description("string")
        .logon(ClusterIdentityLogonArgs.builder()
            .motd("string")
            .motdHeader("string")
            .build())
        .name("string")
        .build());
    
    cluster_identity_resource = powerscale.ClusterIdentity("clusterIdentityResource",
        description="string",
        logon={
            "motd": "string",
            "motd_header": "string",
        },
        name="string")
    
    const clusterIdentityResource = new powerscale.ClusterIdentity("clusterIdentityResource", {
        description: "string",
        logon: {
            motd: "string",
            motdHeader: "string",
        },
        name: "string",
    });
    
    type: powerscale:ClusterIdentity
    properties:
        description: string
        logon:
            motd: string
            motdHeader: string
        name: string
    

    ClusterIdentity 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 ClusterIdentity resource accepts the following input properties:

    Description string
    A description of the cluster.
    Logon ClusterIdentityLogon
    The information displayed when a user logs in to the cluster.
    Name string
    A unique name for this cluster.
    Description string
    A description of the cluster.
    Logon ClusterIdentityLogonArgs
    The information displayed when a user logs in to the cluster.
    Name string
    A unique name for this cluster.
    description String
    A description of the cluster.
    logon ClusterIdentityLogon
    The information displayed when a user logs in to the cluster.
    name String
    A unique name for this cluster.
    description string
    A description of the cluster.
    logon ClusterIdentityLogon
    The information displayed when a user logs in to the cluster.
    name string
    A unique name for this cluster.
    description str
    A description of the cluster.
    logon ClusterIdentityLogonArgs
    The information displayed when a user logs in to the cluster.
    name str
    A unique name for this cluster.
    description String
    A description of the cluster.
    logon Property Map
    The information displayed when a user logs in to the cluster.
    name String
    A unique name for this cluster.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterIdentity 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ClusterIdentity Resource

    Get an existing ClusterIdentity 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?: ClusterIdentityState, opts?: CustomResourceOptions): ClusterIdentity
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            logon: Optional[ClusterIdentityLogonArgs] = None,
            name: Optional[str] = None) -> ClusterIdentity
    func GetClusterIdentity(ctx *Context, name string, id IDInput, state *ClusterIdentityState, opts ...ResourceOption) (*ClusterIdentity, error)
    public static ClusterIdentity Get(string name, Input<string> id, ClusterIdentityState? state, CustomResourceOptions? opts = null)
    public static ClusterIdentity get(String name, Output<String> id, ClusterIdentityState state, CustomResourceOptions options)
    resources:  _:    type: powerscale:ClusterIdentity    get:      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.
    The following state arguments are supported:
    Description string
    A description of the cluster.
    Logon ClusterIdentityLogon
    The information displayed when a user logs in to the cluster.
    Name string
    A unique name for this cluster.
    Description string
    A description of the cluster.
    Logon ClusterIdentityLogonArgs
    The information displayed when a user logs in to the cluster.
    Name string
    A unique name for this cluster.
    description String
    A description of the cluster.
    logon ClusterIdentityLogon
    The information displayed when a user logs in to the cluster.
    name String
    A unique name for this cluster.
    description string
    A description of the cluster.
    logon ClusterIdentityLogon
    The information displayed when a user logs in to the cluster.
    name string
    A unique name for this cluster.
    description str
    A description of the cluster.
    logon ClusterIdentityLogonArgs
    The information displayed when a user logs in to the cluster.
    name str
    A unique name for this cluster.
    description String
    A description of the cluster.
    logon Property Map
    The information displayed when a user logs in to the cluster.
    name String
    A unique name for this cluster.

    Supporting Types

    ClusterIdentityLogon, ClusterIdentityLogonArgs

    Motd string
    The message of the day.
    MotdHeader string
    The header to the message of the day.
    Motd string
    The message of the day.
    MotdHeader string
    The header to the message of the day.
    motd String
    The message of the day.
    motdHeader String
    The header to the message of the day.
    motd string
    The message of the day.
    motdHeader string
    The header to the message of the day.
    motd str
    The message of the day.
    motd_header str
    The header to the message of the day.
    motd String
    The message of the day.
    motdHeader String
    The header to the message of the day.

    Import

    Copyright (c) 2024 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.

    The command is

    $ pulumi import powerscale:index/clusterIdentity:ClusterIdentity example_identity_settings <anyString>
    

    Example:

    $ pulumi import powerscale:index/clusterIdentity:ClusterIdentity example_identity_settings "cluster_identity"
    

    after running this command, populate fields as per your requirement in the config file to start managing this resource.

    Note: running “terraform show” after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell