1. Packages
  2. Cisco ISE Provider
  3. API Docs
  4. network
  5. DeviceGroup
Cisco ISE v0.2.1 published on Saturday, Mar 15, 2025 by Pulumi

ise.network.DeviceGroup

Explore with Pulumi AI

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",
});
Copy
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")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

    }
}
Copy
resources:
  example:
    type: ise:network:DeviceGroup
    properties:
      name: Device Type#All Device Types#Group1
      description: My network device group
      rootGroup: Device Type
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. DeviceGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DeviceGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DeviceGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DeviceGroupArgs
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 deviceGroupResource = new Ise.Network.DeviceGroup("deviceGroupResource", new()
{
    RootGroup = "string",
    Description = "string",
    Name = "string",
});
Copy
example, err := network.NewDeviceGroup(ctx, "deviceGroupResource", &network.DeviceGroupArgs{
	RootGroup:   pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})
Copy
var deviceGroupResource = new DeviceGroup("deviceGroupResource", DeviceGroupArgs.builder()
    .rootGroup("string")
    .description("string")
    .name("string")
    .build());
Copy
device_group_resource = ise.network.DeviceGroup("deviceGroupResource",
    root_group="string",
    description="string",
    name="string")
Copy
const deviceGroupResource = new ise.network.DeviceGroup("deviceGroupResource", {
    rootGroup: "string",
    description: "string",
    name: "string",
});
Copy
type: ise:network:DeviceGroup
properties:
    description: string
    name: string
    rootGroup: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DeviceGroup resource accepts the following input properties:

RootGroup This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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)
resources:  _:    type: ise:network:DeviceGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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"
Copy

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.