avi 31.1.1, Apr 14 25

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.Controllersite

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “Avi: avi.Controllersite” sidebar_current: “docs-avi-resource-controllersite” description: |- Creates and manages Avi ControllerSite.

avi.Controllersite

The ControllerSite resource allows the creation and management of Avi ControllerSite

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";

const foo = new avi.Controllersite("foo", {tenantRef: "/api/tenant/?name=admin"});

import pulumi
import pulumi_avi as avi

foo = avi.Controllersite("foo", tenant_ref="/api/tenant/?name=admin")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewControllersite(ctx, "foo", &avi.ControllersiteArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Controllersite("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Controllersite;
import com.pulumi.avi.ControllersiteArgs;
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 foo = new Controllersite("foo", ControllersiteArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

resources:
  foo:
    type: avi:Controllersite
    properties:
      tenantRef: /api/tenant/?name=admin

Create Controllersite Resource

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

Constructor syntax

new Controllersite(name: string, args: ControllersiteArgs, opts?: CustomResourceOptions);

@overload
def Controllersite(resource_name: str,
                   args: ControllersiteArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def Controllersite(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   address: Optional[str] = None,
                   configpb_attributes: Optional[Sequence[ControllersiteConfigpbAttributeArgs]] = None,
                   controllersite_id: Optional[str] = None,
                   name: Optional[str] = None,
                   port: Optional[str] = None,
                   tenant_ref: Optional[str] = None,
                   uuid: Optional[str] = None)

func NewControllersite(ctx *Context, name string, args ControllersiteArgs, opts ...ResourceOption) (*Controllersite, error)

public Controllersite(string name, ControllersiteArgs args, CustomResourceOptions? opts = null)

public Controllersite(String name, ControllersiteArgs args)
public Controllersite(String name, ControllersiteArgs args, CustomResourceOptions options)

type: avi:Controllersite
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 ControllersiteArgs: 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 ControllersiteArgs: 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 ControllersiteArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ControllersiteArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ControllersiteArgs: 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 controllersiteResource = new Avi.Controllersite("controllersiteResource", new()
{
    Address = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.ControllersiteConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    ControllersiteId = "string",
    Name = "string",
    Port = "string",
    TenantRef = "string",
    Uuid = "string",
});

example, err := avi.NewControllersite(ctx, "controllersiteResource", &avi.ControllersiteArgs{
	Address: pulumi.String("string"),
	ConfigpbAttributes: avi.ControllersiteConfigpbAttributeArray{
		&avi.ControllersiteConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	ControllersiteId: pulumi.String("string"),
	Name:             pulumi.String("string"),
	Port:             pulumi.String("string"),
	TenantRef:        pulumi.String("string"),
	Uuid:             pulumi.String("string"),
})

var controllersiteResource = new Controllersite("controllersiteResource", ControllersiteArgs.builder()
    .address("string")
    .configpbAttributes(ControllersiteConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .controllersiteId("string")
    .name("string")
    .port("string")
    .tenantRef("string")
    .uuid("string")
    .build());

controllersite_resource = avi.Controllersite("controllersiteResource",
    address="string",
    configpb_attributes=[{
        "version": "string",
    }],
    controllersite_id="string",
    name="string",
    port="string",
    tenant_ref="string",
    uuid="string")

const controllersiteResource = new avi.Controllersite("controllersiteResource", {
    address: "string",
    configpbAttributes: [{
        version: "string",
    }],
    controllersiteId: "string",
    name: "string",
    port: "string",
    tenantRef: "string",
    uuid: "string",
});

type: avi:Controllersite
properties:
    address: string
    configpbAttributes:
        - version: string
    controllersiteId: string
    name: string
    port: string
    tenantRef: string
    uuid: string

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

Address string: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<ControllersiteConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ControllersiteId string
Name string: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Port string: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Address string: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []ControllersiteConfigpbAttributeArgs: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ControllersiteId string
Name string: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Port string: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

address String: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<ControllersiteConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
controllersiteId String
name String: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
port String: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

address string: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes ControllersiteConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
controllersiteId string
name string: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
port string: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

address str: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[ControllersiteConfigpbAttributeArgs]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
controllersite_id str
name str: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
port str: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

address String: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
controllersiteId String
name String: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
port String: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Outputs

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

Get an existing Controllersite 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?: ControllersiteState, opts?: CustomResourceOptions): Controllersite

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        configpb_attributes: Optional[Sequence[ControllersiteConfigpbAttributeArgs]] = None,
        controllersite_id: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        uuid: Optional[str] = None) -> Controllersite

func GetControllersite(ctx *Context, name string, id IDInput, state *ControllersiteState, opts ...ResourceOption) (*Controllersite, error)

public static Controllersite Get(string name, Input<string> id, ControllersiteState? state, CustomResourceOptions? opts = null)

public static Controllersite get(String name, Output<String> id, ControllersiteState state, CustomResourceOptions options)

resources:  _:    type: avi:Controllersite    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:

Address string: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<ControllersiteConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ControllersiteId string
Name string: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Port string: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Address string: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []ControllersiteConfigpbAttributeArgs: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ControllersiteId string
Name string: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Port string: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

address String: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<ControllersiteConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
controllersiteId String
name String: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
port String: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

address string: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes ControllersiteConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
controllersiteId string
name string: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
port string: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

address str: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[ControllersiteConfigpbAttributeArgs]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
controllersite_id str
name str: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
port str: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

address String: Ip address or a dns resolvable, fully qualified domain name of the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
controllersiteId String
name String: Name for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
port String: The controller site cluster's rest api port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: Reference for the tenant. It is a reference to an object of type tenant. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Reference for the site controller cluster. Field introduced in 18.2.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.