1. Packages
  2. Vcd Provider
  3. API Docs
  4. getMultisiteOrgData
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getMultisiteOrgData

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Provides a data source to read a VMware Cloud Director Org association data to be used for association with another Org.

    Supported in provider v3.13+

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const my_org = vcd.getOrg({
        name: "my-org",
    });
    const currentOrg = my_org.then(my_org => vcd.getMultisiteOrgData({
        orgId: my_org.id,
        downloadToFile: "filename.xml",
    }));
    
    import pulumi
    import pulumi_vcd as vcd
    
    my_org = vcd.get_org(name="my-org")
    current_org = vcd.get_multisite_org_data(org_id=my_org.id,
        download_to_file="filename.xml")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		my_org, err := vcd.LookupOrg(ctx, &vcd.LookupOrgArgs{
    			Name: "my-org",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = vcd.GetMultisiteOrgData(ctx, &vcd.GetMultisiteOrgDataArgs{
    			OrgId:          my_org.Id,
    			DownloadToFile: pulumi.StringRef("filename.xml"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vcd = Pulumi.Vcd;
    
    return await Deployment.RunAsync(() => 
    {
        var my_org = Vcd.GetOrg.Invoke(new()
        {
            Name = "my-org",
        });
    
        var currentOrg = Vcd.GetMultisiteOrgData.Invoke(new()
        {
            OrgId = my_org.Apply(getOrgResult => getOrgResult.Id),
            DownloadToFile = "filename.xml",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vcd.VcdFunctions;
    import com.pulumi.vcd.inputs.GetOrgArgs;
    import com.pulumi.vcd.inputs.GetMultisiteOrgDataArgs;
    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 my-org = VcdFunctions.getOrg(GetOrgArgs.builder()
                .name("my-org")
                .build());
    
            final var currentOrg = VcdFunctions.getMultisiteOrgData(GetMultisiteOrgDataArgs.builder()
                .orgId(my_org.id())
                .downloadToFile("filename.xml")
                .build());
    
        }
    }
    
    variables:
      my-org:
        fn::invoke:
          function: vcd:getOrg
          arguments:
            name: my-org
      currentOrg:
        fn::invoke:
          function: vcd:getMultisiteOrgData
          arguments:
            orgId: ${["my-org"].id}
            downloadToFile: filename.xml
    

    More information

    See Site and Org association for a broader description of association workflows.

    Using getMultisiteOrgData

    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 getMultisiteOrgData(args: GetMultisiteOrgDataArgs, opts?: InvokeOptions): Promise<GetMultisiteOrgDataResult>
    function getMultisiteOrgDataOutput(args: GetMultisiteOrgDataOutputArgs, opts?: InvokeOptions): Output<GetMultisiteOrgDataResult>
    def get_multisite_org_data(download_to_file: Optional[str] = None,
                               id: Optional[str] = None,
                               org_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetMultisiteOrgDataResult
    def get_multisite_org_data_output(download_to_file: Optional[pulumi.Input[str]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               org_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetMultisiteOrgDataResult]
    func GetMultisiteOrgData(ctx *Context, args *GetMultisiteOrgDataArgs, opts ...InvokeOption) (*GetMultisiteOrgDataResult, error)
    func GetMultisiteOrgDataOutput(ctx *Context, args *GetMultisiteOrgDataOutputArgs, opts ...InvokeOption) GetMultisiteOrgDataResultOutput

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

    public static class GetMultisiteOrgData 
    {
        public static Task<GetMultisiteOrgDataResult> InvokeAsync(GetMultisiteOrgDataArgs args, InvokeOptions? opts = null)
        public static Output<GetMultisiteOrgDataResult> Invoke(GetMultisiteOrgDataInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMultisiteOrgDataResult> getMultisiteOrgData(GetMultisiteOrgDataArgs args, InvokeOptions options)
    public static Output<GetMultisiteOrgDataResult> getMultisiteOrgData(GetMultisiteOrgDataArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getMultisiteOrgData:getMultisiteOrgData
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrgId string
    The ID of the organization for which we need to collect the data.
    DownloadToFile string
    Name of the file that will contain the data needed to associate this Org to another one, either on the same VCD or in a different one. Contains the same data returned in association_data.
    Id string
    OrgId string
    The ID of the organization for which we need to collect the data.
    DownloadToFile string
    Name of the file that will contain the data needed to associate this Org to another one, either on the same VCD or in a different one. Contains the same data returned in association_data.
    Id string
    orgId String
    The ID of the organization for which we need to collect the data.
    downloadToFile String
    Name of the file that will contain the data needed to associate this Org to another one, either on the same VCD or in a different one. Contains the same data returned in association_data.
    id String
    orgId string
    The ID of the organization for which we need to collect the data.
    downloadToFile string
    Name of the file that will contain the data needed to associate this Org to another one, either on the same VCD or in a different one. Contains the same data returned in association_data.
    id string
    org_id str
    The ID of the organization for which we need to collect the data.
    download_to_file str
    Name of the file that will contain the data needed to associate this Org to another one, either on the same VCD or in a different one. Contains the same data returned in association_data.
    id str
    orgId String
    The ID of the organization for which we need to collect the data.
    downloadToFile String
    Name of the file that will contain the data needed to associate this Org to another one, either on the same VCD or in a different one. Contains the same data returned in association_data.
    id String

    getMultisiteOrgData Result

    The following output properties are available:

    AssociationData string
    The data needed to associate this Org to another one. Contains the same data that would be saved into the file defined in download_to_file.
    Associations List<string>
    An alphabetically sorted list of current associations.
    Id string
    NumberOfAssociations double
    The number of current associations with other Orgs.
    OrgId string
    DownloadToFile string
    AssociationData string
    The data needed to associate this Org to another one. Contains the same data that would be saved into the file defined in download_to_file.
    Associations []string
    An alphabetically sorted list of current associations.
    Id string
    NumberOfAssociations float64
    The number of current associations with other Orgs.
    OrgId string
    DownloadToFile string
    associationData String
    The data needed to associate this Org to another one. Contains the same data that would be saved into the file defined in download_to_file.
    associations List<String>
    An alphabetically sorted list of current associations.
    id String
    numberOfAssociations Double
    The number of current associations with other Orgs.
    orgId String
    downloadToFile String
    associationData string
    The data needed to associate this Org to another one. Contains the same data that would be saved into the file defined in download_to_file.
    associations string[]
    An alphabetically sorted list of current associations.
    id string
    numberOfAssociations number
    The number of current associations with other Orgs.
    orgId string
    downloadToFile string
    association_data str
    The data needed to associate this Org to another one. Contains the same data that would be saved into the file defined in download_to_file.
    associations Sequence[str]
    An alphabetically sorted list of current associations.
    id str
    number_of_associations float
    The number of current associations with other Orgs.
    org_id str
    download_to_file str
    associationData String
    The data needed to associate this Org to another one. Contains the same data that would be saved into the file defined in download_to_file.
    associations List<String>
    An alphabetically sorted list of current associations.
    id String
    numberOfAssociations Number
    The number of current associations with other Orgs.
    orgId String
    downloadToFile String

    Package Details

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