1. Packages
  2. Packages
  3. Powerscale Provider
  4. API Docs
  5. NfsAlias
Viewing docs for powerscale 1.8.1
published on Wednesday, Apr 1, 2026 by dell
Viewing docs for powerscale 1.8.1
published on Wednesday, Apr 1, 2026 by dell

    This resource is used to manage the NFS Alias entity of PowerScale Array. We can Create, Update and Delete the NFS Aliases using this resource. We can also import an existing NFS Alias from PowerScale array.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as powerscale from "@pulumi/powerscale";
    
    //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.
    // Available actions: Create, Update, Delete and Import.
    // After `pulumi up` of this example file will create the nfs alias on the PowerScale array with the attributes set in the config.
    // For update, only name and path is supported. Zone Cannot be updated.
    const example = new powerscale.NfsAlias("example", {
        name: "/testNfs",
        path: "/ifs/data",
        zone: "dev-tcz",
    });
    
    import pulumi
    import pulumi_powerscale as powerscale
    
    #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.
    # Available actions: Create, Update, Delete and Import.
    # After `pulumi up` of this example file will create the nfs alias on the PowerScale array with the attributes set in the config.
    # For update, only name and path is supported. Zone Cannot be updated.
    example = powerscale.NfsAlias("example",
        name="/testNfs",
        path="/ifs/data",
        zone="dev-tcz")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerscale/powerscale"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// 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.
    		// Available actions: Create, Update, Delete and Import.
    		// After `pulumi up` of this example file will create the nfs alias on the PowerScale array with the attributes set in the config.
    		// For update, only name and path is supported. Zone Cannot be updated.
    		_, err := powerscale.NewNfsAlias(ctx, "example", &powerscale.NfsAliasArgs{
    			Name: pulumi.String("/testNfs"),
    			Path: pulumi.String("/ifs/data"),
    			Zone: pulumi.String("dev-tcz"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Powerscale = Pulumi.Powerscale;
    
    return await Deployment.RunAsync(() => 
    {
        //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.
        // Available actions: Create, Update, Delete and Import.
        // After `pulumi up` of this example file will create the nfs alias on the PowerScale array with the attributes set in the config.
        // For update, only name and path is supported. Zone Cannot be updated.
        var example = new Powerscale.NfsAlias("example", new()
        {
            Name = "/testNfs",
            Path = "/ifs/data",
            Zone = "dev-tcz",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.powerscale.NfsAlias;
    import com.pulumi.powerscale.NfsAliasArgs;
    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) 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.
            // Available actions: Create, Update, Delete and Import.
            // After `pulumi up` of this example file will create the nfs alias on the PowerScale array with the attributes set in the config.
            // For update, only name and path is supported. Zone Cannot be updated.
            var example = new NfsAlias("example", NfsAliasArgs.builder()
                .name("/testNfs")
                .path("/ifs/data")
                .zone("dev-tcz")
                .build());
    
        }
    }
    
    resources:
      # /*
      # 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.
      # */
    
    
      # Available actions: Create, Update, Delete and Import.
      # After `pulumi up` of this example file will create the nfs alias on the PowerScale array with the attributes set in the config.
      # For update, only name and path is supported. Zone Cannot be updated.
      example:
        type: powerscale:NfsAlias
        properties:
          name: /testNfs
          path: /ifs/data
          zone: dev-tcz
    

    Create NfsAlias Resource

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

    Constructor syntax

    new NfsAlias(name: string, args: NfsAliasArgs, opts?: CustomResourceOptions);
    @overload
    def NfsAlias(resource_name: str,
                 args: NfsAliasArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def NfsAlias(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 path: Optional[str] = None,
                 name: Optional[str] = None,
                 zone: Optional[str] = None)
    func NewNfsAlias(ctx *Context, name string, args NfsAliasArgs, opts ...ResourceOption) (*NfsAlias, error)
    public NfsAlias(string name, NfsAliasArgs args, CustomResourceOptions? opts = null)
    public NfsAlias(String name, NfsAliasArgs args)
    public NfsAlias(String name, NfsAliasArgs args, CustomResourceOptions options)
    
    type: powerscale:NfsAlias
    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 NfsAliasArgs
    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 NfsAliasArgs
    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 NfsAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NfsAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NfsAliasArgs
    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 nfsAliasResource = new Powerscale.NfsAlias("nfsAliasResource", new()
    {
        Path = "string",
        Name = "string",
        Zone = "string",
    });
    
    example, err := powerscale.NewNfsAlias(ctx, "nfsAliasResource", &powerscale.NfsAliasArgs{
    	Path: pulumi.String("string"),
    	Name: pulumi.String("string"),
    	Zone: pulumi.String("string"),
    })
    
    var nfsAliasResource = new NfsAlias("nfsAliasResource", NfsAliasArgs.builder()
        .path("string")
        .name("string")
        .zone("string")
        .build());
    
    nfs_alias_resource = powerscale.NfsAlias("nfsAliasResource",
        path="string",
        name="string",
        zone="string")
    
    const nfsAliasResource = new powerscale.NfsAlias("nfsAliasResource", {
        path: "string",
        name: "string",
        zone: "string",
    });
    
    type: powerscale:NfsAlias
    properties:
        name: string
        path: string
        zone: string
    

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

    Path string
    Specifies the path to which the alias points.
    Name string
    Specifies the name by which the alias can be referenced.
    Zone string
    Specifies the zone in which the alias is valid.
    Path string
    Specifies the path to which the alias points.
    Name string
    Specifies the name by which the alias can be referenced.
    Zone string
    Specifies the zone in which the alias is valid.
    path String
    Specifies the path to which the alias points.
    name String
    Specifies the name by which the alias can be referenced.
    zone String
    Specifies the zone in which the alias is valid.
    path string
    Specifies the path to which the alias points.
    name string
    Specifies the name by which the alias can be referenced.
    zone string
    Specifies the zone in which the alias is valid.
    path str
    Specifies the path to which the alias points.
    name str
    Specifies the name by which the alias can be referenced.
    zone str
    Specifies the zone in which the alias is valid.
    path String
    Specifies the path to which the alias points.
    name String
    Specifies the name by which the alias can be referenced.
    zone String
    Specifies the zone in which the alias is valid.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NfsAlias resource produces the following output properties:

    Health string
    Specifies whether the alias is usable.
    Id string
    The provider-assigned unique ID for this managed resource.
    Health string
    Specifies whether the alias is usable.
    Id string
    The provider-assigned unique ID for this managed resource.
    health String
    Specifies whether the alias is usable.
    id String
    The provider-assigned unique ID for this managed resource.
    health string
    Specifies whether the alias is usable.
    id string
    The provider-assigned unique ID for this managed resource.
    health str
    Specifies whether the alias is usable.
    id str
    The provider-assigned unique ID for this managed resource.
    health String
    Specifies whether the alias is usable.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NfsAlias Resource

    Get an existing NfsAlias 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?: NfsAliasState, opts?: CustomResourceOptions): NfsAlias
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            health: Optional[str] = None,
            name: Optional[str] = None,
            path: Optional[str] = None,
            zone: Optional[str] = None) -> NfsAlias
    func GetNfsAlias(ctx *Context, name string, id IDInput, state *NfsAliasState, opts ...ResourceOption) (*NfsAlias, error)
    public static NfsAlias Get(string name, Input<string> id, NfsAliasState? state, CustomResourceOptions? opts = null)
    public static NfsAlias get(String name, Output<String> id, NfsAliasState state, CustomResourceOptions options)
    resources:  _:    type: powerscale:NfsAlias    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:
    Health string
    Specifies whether the alias is usable.
    Name string
    Specifies the name by which the alias can be referenced.
    Path string
    Specifies the path to which the alias points.
    Zone string
    Specifies the zone in which the alias is valid.
    Health string
    Specifies whether the alias is usable.
    Name string
    Specifies the name by which the alias can be referenced.
    Path string
    Specifies the path to which the alias points.
    Zone string
    Specifies the zone in which the alias is valid.
    health String
    Specifies whether the alias is usable.
    name String
    Specifies the name by which the alias can be referenced.
    path String
    Specifies the path to which the alias points.
    zone String
    Specifies the zone in which the alias is valid.
    health string
    Specifies whether the alias is usable.
    name string
    Specifies the name by which the alias can be referenced.
    path string
    Specifies the path to which the alias points.
    zone string
    Specifies the zone in which the alias is valid.
    health str
    Specifies whether the alias is usable.
    name str
    Specifies the name by which the alias can be referenced.
    path str
    Specifies the path to which the alias points.
    zone str
    Specifies the zone in which the alias is valid.
    health String
    Specifies whether the alias is usable.
    name String
    Specifies the name by which the alias can be referenced.
    path String
    Specifies the path to which the alias points.
    zone String
    Specifies the zone in which the alias is valid.

    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/nfsAlias:NfsAlias example [<zoneID>]:<name>
    

    Example 1: is Optional, defaults to System:

    $ pulumi import powerscale:index/nfsAlias:NfsAlias example "alias"
    

    Example 2:

    $ pulumi import powerscale:index/nfsAlias:NfsAlias example zoneID:alias
    

    after running this command, populate parameters in the config file to start managing this resource.

    Note: running “terraform show” after importing shows the current config/state of 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.
    Viewing docs for powerscale 1.8.1
    published on Wednesday, Apr 1, 2026 by dell
      Try Pulumi Cloud free. Your team will thank you.