1. Packages
  2. Ise
  3. API Docs
  4. network
  5. DeviceGroup
Cisco ISE v0.1.2 published on Wednesday, May 15, 2024 by Pulumi

ise.network.DeviceGroup

Explore with Pulumi AI

ise logo
Cisco ISE v0.1.2 published on Wednesday, May 15, 2024 by Pulumi

    This resource can manage a Network Device Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ise from "@pulumi/ise";
    
    const example = new ise.network.DeviceGroup("example", {
        name: "Device Type#All Device Types#Group1",
        description: "My network device group",
        rootGroup: "Device Type",
    });
    
    import pulumi
    import pulumi_ise as ise
    
    example = ise.network.DeviceGroup("example",
        name="Device Type#All Device Types#Group1",
        description="My network device group",
        root_group="Device Type")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-ise/sdk/go/ise/network"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := network.NewDeviceGroup(ctx, "example", &network.DeviceGroupArgs{
    			Name:        pulumi.String("Device Type#All Device Types#Group1"),
    			Description: pulumi.String("My network device group"),
    			RootGroup:   pulumi.String("Device Type"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ise = Pulumi.Ise;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Ise.Network.DeviceGroup("example", new()
        {
            Name = "Device Type#All Device Types#Group1",
            Description = "My network device group",
            RootGroup = "Device Type",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ise.network.DeviceGroup;
    import com.pulumi.ise.network.DeviceGroupArgs;
    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) {
            var example = new DeviceGroup("example", DeviceGroupArgs.builder()        
                .name("Device Type#All Device Types#Group1")
                .description("My network device group")
                .rootGroup("Device Type")
                .build());
    
        }
    }
    
    resources:
      example:
        type: ise:network:DeviceGroup
        properties:
          name: Device Type#All Device Types#Group1
          description: My network device group
          rootGroup: Device Type
    

    Create DeviceGroup Resource

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

    Constructor syntax

    new DeviceGroup(name: string, args: DeviceGroupArgs, opts?: CustomResourceOptions);
    @overload
    def DeviceGroup(resource_name: str,
                    args: DeviceGroupArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def DeviceGroup(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    root_group: Optional[str] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None)
    func NewDeviceGroup(ctx *Context, name string, args DeviceGroupArgs, opts ...ResourceOption) (*DeviceGroup, error)
    public DeviceGroup(string name, DeviceGroupArgs args, CustomResourceOptions? opts = null)
    public DeviceGroup(String name, DeviceGroupArgs args)
    public DeviceGroup(String name, DeviceGroupArgs args, CustomResourceOptions options)
    
    type: ise:network:DeviceGroup
    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 DeviceGroupArgs
    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 DeviceGroupArgs
    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 DeviceGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeviceGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var deviceGroupResource = new Ise.Network.DeviceGroup("deviceGroupResource", new()
    {
        RootGroup = "string",
        Description = "string",
        Name = "string",
    });
    
    example, err := network.NewDeviceGroup(ctx, "deviceGroupResource", &network.DeviceGroupArgs{
    	RootGroup:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var deviceGroupResource = new DeviceGroup("deviceGroupResource", DeviceGroupArgs.builder()        
        .rootGroup("string")
        .description("string")
        .name("string")
        .build());
    
    device_group_resource = ise.network.DeviceGroup("deviceGroupResource",
        root_group="string",
        description="string",
        name="string")
    
    const deviceGroupResource = new ise.network.DeviceGroup("deviceGroupResource", {
        rootGroup: "string",
        description: "string",
        name: "string",
    });
    
    type: ise:network:DeviceGroup
    properties:
        description: string
        name: string
        rootGroup: string
    

    DeviceGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DeviceGroup resource accepts the following input properties:

    RootGroup string
    The name of the root device group.
    Description string
    Description
    Name string
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    RootGroup string
    The name of the root device group.
    Description string
    Description
    Name string
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    rootGroup String
    The name of the root device group.
    description String
    Description
    name String
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    rootGroup string
    The name of the root device group.
    description string
    Description
    name string
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    root_group str
    The name of the root device group.
    description str
    Description
    name str
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    rootGroup String
    The name of the root device group.
    description String
    Description
    name String
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DeviceGroup 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 DeviceGroup Resource

    Get an existing DeviceGroup 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?: DeviceGroupState, opts?: CustomResourceOptions): DeviceGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            root_group: Optional[str] = None) -> DeviceGroup
    func GetDeviceGroup(ctx *Context, name string, id IDInput, state *DeviceGroupState, opts ...ResourceOption) (*DeviceGroup, error)
    public static DeviceGroup Get(string name, Input<string> id, DeviceGroupState? state, CustomResourceOptions? opts = null)
    public static DeviceGroup get(String name, Output<String> id, DeviceGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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
    Description
    Name string
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    RootGroup string
    The name of the root device group.
    Description string
    Description
    Name string
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    RootGroup string
    The name of the root device group.
    description String
    Description
    name String
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    rootGroup String
    The name of the root device group.
    description string
    Description
    name string
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    rootGroup string
    The name of the root device group.
    description str
    Description
    name str
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    root_group str
    The name of the root device group.
    description String
    Description
    name String
    The name of the network device group including its hierarchy, e.g. Device Type#All Device Types#ACCESS.
    rootGroup String
    The name of the root device group.

    Import

    $ pulumi import ise:network/deviceGroup:DeviceGroup example "76d24097-41c4-4558-a4d0-a8c07ac08470"
    

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

    Package Details

    Repository
    ise pulumi/pulumi-ise
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ise Terraform Provider.
    ise logo
    Cisco ISE v0.1.2 published on Wednesday, May 15, 2024 by Pulumi