1. Packages
  2. Mso Provider
  3. API Docs
  4. getSchemaSiteVrfRegion
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.getSchemaSiteVrfRegion

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

    Data source for MSO Schema Site VRF Region.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as mso from "@pulumi/mso";
    
    const example = mso.getSchemaSiteVrfRegion({
        schemaId: data.mso_schema.schema1.id,
        siteId: data.mso_site.site1.id,
        templateName: "Template1",
        vrfName: "Campus",
        regionName: "westus",
    });
    
    import pulumi
    import pulumi_mso as mso
    
    example = mso.get_schema_site_vrf_region(schema_id=data["mso_schema"]["schema1"]["id"],
        site_id=data["mso_site"]["site1"]["id"],
        template_name="Template1",
        vrf_name="Campus",
        region_name="westus")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/mso/mso"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mso.LookupSchemaSiteVrfRegion(ctx, &mso.LookupSchemaSiteVrfRegionArgs{
    			SchemaId:     data.Mso_schema.Schema1.Id,
    			SiteId:       data.Mso_site.Site1.Id,
    			TemplateName: "Template1",
    			VrfName:      "Campus",
    			RegionName:   "westus",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mso = Pulumi.Mso;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Mso.GetSchemaSiteVrfRegion.Invoke(new()
        {
            SchemaId = data.Mso_schema.Schema1.Id,
            SiteId = data.Mso_site.Site1.Id,
            TemplateName = "Template1",
            VrfName = "Campus",
            RegionName = "westus",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mso.MsoFunctions;
    import com.pulumi.mso.inputs.GetSchemaSiteVrfRegionArgs;
    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) {
            final var example = MsoFunctions.getSchemaSiteVrfRegion(GetSchemaSiteVrfRegionArgs.builder()
                .schemaId(data.mso_schema().schema1().id())
                .siteId(data.mso_site().site1().id())
                .templateName("Template1")
                .vrfName("Campus")
                .regionName("westus")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: mso:getSchemaSiteVrfRegion
          arguments:
            schemaId: ${data.mso_schema.schema1.id}
            siteId: ${data.mso_site.site1.id}
            templateName: Template1
            vrfName: Campus
            regionName: westus
    

    Argument Reference

    • schema_id - (Required) The schema ID under which the Region is deployed.
    • site_id - (Required) The site ID under which the Region is deployed.
    • template_name - (Required) The template name under which the Region is deployed.
    • vrf_name - (Required) The name of the VRF under which the Region is deployed.
    • region_name - (Required) The name of the Region.

    Attribute Reference

    • vpn_gateway - (Read-Only) The VPN gateway flag of the Region.
    • hub_network_enable - (Read-Only) The Hub Network enable flag of the Region.
    • cidr - (Read-Only) A list of CIDRs for the Region.
      • cidr_ip - (Read-Only) The IP range of the Region.
      • primary - (Read-Only) Whether this is the primary CIDR.
      • subnet - (Read-Only) A list of Subnets for the CIDR.
        • ip - (Read-Only) The P address of the subnet.
        • name - (Read-Only) The name of the subnet.
        • zone - (Read-Only) The availability zone name of the Subnet.
        • usage - (Read-Only) The usage of the Subnet.
        • subnet_group - (Read-Only) The group of the Subnet.
    • hub_network - (Read-Only) A list of Hub Networks for the Region.
      • name - (Read-Only) The name of the hub network.
      • tenant_name - (Read-Only) The tenant name of the hub network.

    Using getSchemaSiteVrfRegion

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSchemaSiteVrfRegion(args: GetSchemaSiteVrfRegionArgs, opts?: InvokeOptions): Promise<GetSchemaSiteVrfRegionResult>
    function getSchemaSiteVrfRegionOutput(args: GetSchemaSiteVrfRegionOutputArgs, opts?: InvokeOptions): Output<GetSchemaSiteVrfRegionResult>
    def get_schema_site_vrf_region(id: Optional[str] = None,
                                   region_name: Optional[str] = None,
                                   schema_id: Optional[str] = None,
                                   site_id: Optional[str] = None,
                                   template_name: Optional[str] = None,
                                   vrf_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetSchemaSiteVrfRegionResult
    def get_schema_site_vrf_region_output(id: Optional[pulumi.Input[str]] = None,
                                   region_name: Optional[pulumi.Input[str]] = None,
                                   schema_id: Optional[pulumi.Input[str]] = None,
                                   site_id: Optional[pulumi.Input[str]] = None,
                                   template_name: Optional[pulumi.Input[str]] = None,
                                   vrf_name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetSchemaSiteVrfRegionResult]
    func LookupSchemaSiteVrfRegion(ctx *Context, args *LookupSchemaSiteVrfRegionArgs, opts ...InvokeOption) (*LookupSchemaSiteVrfRegionResult, error)
    func LookupSchemaSiteVrfRegionOutput(ctx *Context, args *LookupSchemaSiteVrfRegionOutputArgs, opts ...InvokeOption) LookupSchemaSiteVrfRegionResultOutput

    > Note: This function is named LookupSchemaSiteVrfRegion in the Go SDK.

    public static class GetSchemaSiteVrfRegion 
    {
        public static Task<GetSchemaSiteVrfRegionResult> InvokeAsync(GetSchemaSiteVrfRegionArgs args, InvokeOptions? opts = null)
        public static Output<GetSchemaSiteVrfRegionResult> Invoke(GetSchemaSiteVrfRegionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSchemaSiteVrfRegionResult> getSchemaSiteVrfRegion(GetSchemaSiteVrfRegionArgs args, InvokeOptions options)
    public static Output<GetSchemaSiteVrfRegionResult> getSchemaSiteVrfRegion(GetSchemaSiteVrfRegionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: mso:index/getSchemaSiteVrfRegion:getSchemaSiteVrfRegion
      arguments:
        # arguments dictionary

    The following arguments are supported:

    RegionName string
    SchemaId string
    SiteId string
    TemplateName string
    VrfName string
    Id string
    RegionName string
    SchemaId string
    SiteId string
    TemplateName string
    VrfName string
    Id string
    regionName String
    schemaId String
    siteId String
    templateName String
    vrfName String
    id String
    regionName string
    schemaId string
    siteId string
    templateName string
    vrfName string
    id string
    regionName String
    schemaId String
    siteId String
    templateName String
    vrfName String
    id String

    getSchemaSiteVrfRegion Result

    The following output properties are available:

    Cidrs List<GetSchemaSiteVrfRegionCidr>
    HubNetwork Dictionary<string, string>
    HubNetworkEnable bool
    Id string
    RegionName string
    SchemaId string
    SiteId string
    TemplateName string
    VpnGateway bool
    VrfName string
    cidrs GetSchemaSiteVrfRegionCidr[]
    hubNetwork {[key: string]: string}
    hubNetworkEnable boolean
    id string
    regionName string
    schemaId string
    siteId string
    templateName string
    vpnGateway boolean
    vrfName string
    cidrs List<Property Map>
    hubNetwork Map<String>
    hubNetworkEnable Boolean
    id String
    regionName String
    schemaId String
    siteId String
    templateName String
    vpnGateway Boolean
    vrfName String

    Supporting Types

    GetSchemaSiteVrfRegionCidr

    GetSchemaSiteVrfRegionCidrSubnet

    Ip string
    Name string
    SubnetGroup string
    Usage string
    Zone string
    Ip string
    Name string
    SubnetGroup string
    Usage string
    Zone string
    ip String
    name String
    subnetGroup String
    usage String
    zone String
    ip string
    name string
    subnetGroup string
    usage string
    zone string
    ip str
    name str
    subnet_group str
    usage str
    zone str
    ip String
    name String
    subnetGroup String
    usage String
    zone String

    Package Details

    Repository
    mso ciscodevnet/terraform-provider-mso
    License
    Notes
    This Pulumi package is based on the mso Terraform Provider.
    mso logo
    mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet