netcoreapp3.1/VMware.Sdk.Vcf.SddcManager.Cmdlets.dll-Help.xml
|
<?xml version="1.0" encoding="us-ascii"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfAddOnInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>AddOnInfo</command:noun> <maml:description> <maml:para>AddOn contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>AddOn contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfAddOnInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Add on software version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Component name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vendor</maml:name> <maml:Description> <maml:para>vendor</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>Add On display name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayVersion</maml:name> <maml:Description> <maml:para>Add On display version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Add on software version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Component name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vendor</maml:name> <maml:Description> <maml:para>vendor</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>Add On display name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayVersion</maml:name> <maml:Description> <maml:para>Add On display version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AddOnInfo = Initialize-VcfAddOnInfo -_Version "2.0-1" -Name "DELL-sample-Addon" -Vendor "Dell" -DisplayName "MyDisplayName" -DisplayVersion "MyDisplayVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAddOnInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AddOnInfo = Initialize-VcfAddOnInfo -_Version "2.0-1" -Name "DELL-sample-Addon" -Vendor "Dell" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAddOnInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/AddOnInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfAdvancedOptions</command:name> <command:verb>Initialize</command:verb> <command:noun>AdvancedOptions</command:noun> <maml:description> <maml:para>Advanced Options used to add Cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Advanced Options used to add Cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfAdvancedOptions</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EvcMode</maml:name> <maml:Description> <maml:para>EVC mode for new cluster, if needed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HighAvailability</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HighAvailability</command:parameterValue> <dev:type> <maml:name>HighAvailability</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EvcMode</maml:name> <maml:Description> <maml:para>EVC mode for new cluster, if needed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HighAvailability</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HighAvailability</command:parameterValue> <dev:type> <maml:name>HighAvailability</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAdvancedOptions with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $AdvancedOptions = Initialize-VcfAdvancedOptions </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAdvancedOptions with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/AdvancedOptions</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHighAvailability</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfAliasSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>AliasSpec</command:noun> <maml:description> <maml:para>Alias Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Alias Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfAliasSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Aliases</maml:name> <maml:Description> <maml:para>Aliases for bundle component type and version.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceUpdate</maml:name> <maml:Description> <maml:para>Flag for force update version alias configuration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Aliases</maml:name> <maml:Description> <maml:para>Aliases for bundle component type and version.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceUpdate</maml:name> <maml:Description> <maml:para>Flag for force update version alias configuration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AliasSpec = Initialize-VcfAliasSpec -Aliases "MyAliases" -ForceUpdate $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAliasSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AliasSpec = Initialize-VcfAliasSpec -Aliases "MyAliases" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAliasSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/AliasSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfArtifact</command:name> <command:verb>Initialize</command:verb> <command:noun>Artifact</command:noun> <maml:description> <maml:para>Patch rest model that is located in the Product Version Catalog, these models are consumed by LCM's Flex BOM workflows.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Patch rest model that is located in the Product Version Catalog, these models are consumed by LCM's Flex BOM workflows.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfArtifact</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Bundles</maml:name> <maml:Description> <maml:para>List of bundle artifacts for corresponding product patch version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BundleInfo></command:parameterValue> <dev:type> <maml:name>List<BundleInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Bundles</maml:name> <maml:Description> <maml:para>List of bundle artifacts for corresponding product patch version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BundleInfo></command:parameterValue> <dev:type> <maml:name>List<BundleInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BundleInfo = Initialize-VcfBundleInfo -Id "MyId" -Type "MyType" -Name "MyName" $Artifact = Initialize-VcfArtifact -Bundles $BundleInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfArtifact with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Artifact = Initialize-VcfArtifact </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfArtifact with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Artifact</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfAssessmentPartialRetryInput</command:name> <command:verb>Initialize</command:verb> <command:noun>AssessmentPartialRetryInput</command:noun> <maml:description> <maml:para>Spec for assessment retry</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec for assessment retry</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfAssessmentPartialRetryInput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorIds</maml:name> <maml:Description> <maml:para>List of error ids to retry</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Options</maml:name> <maml:Description> <maml:para>Options map (toggles) to control assessment flow. Available toggles 'discoveryCaching' - if set to true the assessment engine will use the Domain data (if present) from previous discovery execution. If any of the passed in the request domains is not present in the cache the Discovery is triggered for ALL domains (even the ones existing in the cache). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorIds</maml:name> <maml:Description> <maml:para>List of error ids to retry</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Options</maml:name> <maml:Description> <maml:para>Options map (toggles) to control assessment flow. Available toggles 'discoveryCaching' - if set to true the assessment engine will use the Domain data (if present) from previous discovery execution. If any of the passed in the request domains is not present in the cache the Discovery is triggered for ALL domains (even the ones existing in the cache). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AssessmentPartialRetryInput = Initialize-VcfAssessmentPartialRetryInput -ErrorIds "MyErrorIds" -Options @{ key_example = "{"discoveryCaching":"true"}" } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAssessmentPartialRetryInput with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AssessmentPartialRetryInput = Initialize-VcfAssessmentPartialRetryInput -ErrorIds "MyErrorIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAssessmentPartialRetryInput with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/AssessmentPartialRetryInput</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfAssociatedTask</command:name> <command:verb>Initialize</command:verb> <command:noun>AssociatedTask</command:noun> <maml:description> <maml:para>Task association for a resource warning. Indicates in which task the resource warning occurred</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Task association for a resource warning. Indicates in which task the resource warning occurred</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfAssociatedTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>ID of the task where the warning for the resource occurred</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubTaskId</maml:name> <maml:Description> <maml:para>ID of the subtask where the warning for the resource occurred</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>ID of the task where the warning for the resource occurred</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubTaskId</maml:name> <maml:Description> <maml:para>ID of the subtask where the warning for the resource occurred</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AssociatedTask = Initialize-VcfAssociatedTask -TaskId "MyTaskId" -SubTaskId "MySubTaskId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAssociatedTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AssociatedTask = Initialize-VcfAssociatedTask -TaskId "MyTaskId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAssociatedTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/AssociatedTask</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfAsyncPatch</command:name> <command:verb>Initialize</command:verb> <command:noun>AsyncPatch</command:noun> <maml:description> <maml:para>Async patch bundle rest model that is located in the 2.0 manifest, these models are consumed by LCM's async patch workflows to determine if customer can download patch in list and apply.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Async patch bundle rest model that is located in the 2.0 manifest, these models are consumed by LCM's async patch workflows to determine if customer can download patch in list and apply.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfAsyncPatch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersion</maml:name> <maml:Description> <maml:para>Product version of the async patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SupportedSkuTypes</maml:name> <maml:Description> <maml:para>Supported SKU types of the async patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InputSpecUrl</maml:name> <maml:Description> <maml:para>Input spec URL of the async patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcHotPatchInfo</maml:name> <maml:Description> <maml:para>Sddc hot patch info for each sddc manager service (lcm, dm, om, commonsvc)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<SddcHotPatchInfo>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<SddcHotPatchInfo>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersion</maml:name> <maml:Description> <maml:para>Product version of the async patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SupportedSkuTypes</maml:name> <maml:Description> <maml:para>Supported SKU types of the async patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InputSpecUrl</maml:name> <maml:Description> <maml:para>Input spec URL of the async patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcHotPatchInfo</maml:name> <maml:Description> <maml:para>Sddc hot patch info for each sddc manager service (lcm, dm, om, commonsvc)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<SddcHotPatchInfo>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<SddcHotPatchInfo>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AsyncPatch = Initialize-VcfAsyncPatch -ProductVersion "MyProductVersion" -SupportedSkuTypes "One among: VXRAIL, VSAN" -InputSpecUrl "MyInputSpecUrl" -SddcHotPatchInfo @{ key_example = $SddcHotPatchInfo = Initialize-VcfSddcHotPatchInfo -_Version "My_Version" -SddcHotPatchMinTargetVcfVersion "MySddcHotPatchMinTargetVcfVersion" } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAsyncPatch with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AsyncPatch = Initialize-VcfAsyncPatch -ProductVersion "MyProductVersion" -SupportedSkuTypes "One among: VXRAIL, VSAN" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAsyncPatch with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/AsyncPatch</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVras</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVras</command:noun> <maml:description> <maml:para>Retrieve a list of VMware Aria Automation instances</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVras</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVra</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVras </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVras with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVras </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVras with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vras/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfAutoRotateCredentialPolicyInputSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>AutoRotateCredentialPolicyInputSpec</command:noun> <maml:description> <maml:para>Represents password auto rotate config details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents password auto rotate config details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfAutoRotateCredentialPolicyInputSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FrequencyInDays</maml:name> <maml:Description> <maml:para>Frequency in days</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableAutoRotatePolicy</maml:name> <maml:Description> <maml:para> Enable or disable auto rotate policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FrequencyInDays</maml:name> <maml:Description> <maml:para>Frequency in days</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableAutoRotatePolicy</maml:name> <maml:Description> <maml:para> Enable or disable auto rotate policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AutoRotateCredentialPolicyInputSpec = Initialize-VcfAutoRotateCredentialPolicyInputSpec -FrequencyInDays 0 -EnableAutoRotatePolicy $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAutoRotateCredentialPolicyInputSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AutoRotateCredentialPolicyInputSpec = Initialize-VcfAutoRotateCredentialPolicyInputSpec -EnableAutoRotatePolicy $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAutoRotateCredentialPolicyInputSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/AutoRotateCredentialPolicyInputSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfAvn</command:name> <command:verb>Initialize</command:verb> <command:noun>Avn</command:noun> <maml:description> <maml:para>Defines an Application virtual Network (AVN) and its attributes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Defines an Application virtual Network (AVN) and its attributes</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfAvn</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The UUID of the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>User provided name of the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RegionType</maml:name> <maml:Description> <maml:para>The region type of AVN; X_REGION or REGION_A</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Subnet</maml:name> <maml:Description> <maml:para>Subnet assigned to the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubnetMask</maml:name> <maml:Description> <maml:para>Subnet mask for the network assigned to the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>Gateway of the AVN subnet</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mtu</maml:name> <maml:Description> <maml:para>MTU for the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VlanId</maml:name> <maml:Description> <maml:para>VLAN ID for the VLAN backed AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PortGroupName</maml:name> <maml:Description> <maml:para>Port group name identifying the AVN on the distributed switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>AVN search domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RouterName</maml:name> <maml:Description> <maml:para>Name of Tier-1 Gateway AVN is connected to</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The UUID of the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>User provided name of the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RegionType</maml:name> <maml:Description> <maml:para>The region type of AVN; X_REGION or REGION_A</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Subnet</maml:name> <maml:Description> <maml:para>Subnet assigned to the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubnetMask</maml:name> <maml:Description> <maml:para>Subnet mask for the network assigned to the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>Gateway of the AVN subnet</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mtu</maml:name> <maml:Description> <maml:para>MTU for the AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VlanId</maml:name> <maml:Description> <maml:para>VLAN ID for the VLAN backed AVN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PortGroupName</maml:name> <maml:Description> <maml:para>Port group name identifying the AVN on the distributed switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>AVN search domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RouterName</maml:name> <maml:Description> <maml:para>Name of Tier-1 Gateway AVN is connected to</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Avn = Initialize-VcfAvn -Id "3f39d4a1-78d2-11e8-af85-f1cf26258cdc" -Name "vRealize-AVN" -RegionType "REGION_A" -Subnet "192.168.31.0" -SubnetMask "255.255.255.0" -Gateway "192.168.31.1" -Mtu 1600 -VlanId 30 -PortGroupName "sfo-m01-seg01-pg" -DomainName "rainpole.io" -RouterName "sfo-m01-ec01-t1-gw01" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAvn with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Avn = Initialize-VcfAvn -Name "vRealize-AVN" -RegionType "REGION_A" -Subnet "192.168.31.0" -SubnetMask "255.255.255.0" -Gateway "192.168.31.1" -Mtu 1600 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAvn with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Avn</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCreateAvns</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCreateAvns</command:noun> <maml:description> <maml:para>Create Application Virtual Networks (AVN)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCreateAvns</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AvnsCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AvnsCreationSpec</command:parameterValue> <dev:type> <maml:name>AvnsCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AvnsCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AvnsCreationSpec</command:parameterValue> <dev:type> <maml:name>AvnsCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Avn = Initialize-VcfAvn -Id "3f39d4a1-78d2-11e8-af85-f1cf26258cdc" -Name "vRealize-AVN" -RegionType "REGION_A" -Subnet "192.168.31.0" -SubnetMask "255.255.255.0" -Gateway "192.168.31.1" -Mtu 1600 -VlanId 30 -PortGroupName "sfo-m01-seg01-pg" -DomainName "rainpole.io" -RouterName "sfo-m01-ec01-t1-gw01" $AvnsCreationSpec = Initialize-VcfAvnsCreationSpec -EdgeClusterId "3f39d4a1-78d2-11e8-af85-f1cf26258cdc" -Avns $Avn Invoke-VcfCreateAvns -avnsCreationSpec $avnsCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateAvns with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Avn = Initialize-VcfAvn -Name "vRealize-AVN" -RegionType "REGION_A" -Subnet "192.168.31.0" -SubnetMask "255.255.255.0" -Gateway "192.168.31.1" -Mtu 1600 $AvnsCreationSpec = Initialize-VcfAvnsCreationSpec -Avns $Avn Invoke-VcfCreateAvns -avnsCreationSpec $avnsCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateAvns with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/avns/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfAvnsCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetAvns</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetAvns</command:noun> <maml:description> <maml:para>Retrieve Application Virtual Network (AVN) details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns all matching AVNs</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetAvns</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RegionType</maml:name> <maml:Description> <maml:para>Pass an optional AVN region type matching either Region-A or X-Region</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RegionType</maml:name> <maml:Description> <maml:para>Pass an optional AVN region type matching either Region-A or X-Region</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Avn></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetAvns -regionType "MyregionType" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetAvns with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetAvns </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetAvns with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/avns/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateAvnSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateAvnSpec</command:noun> <maml:description> <maml:para>Perform validation of the AvnsCreationSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns Validation report</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateAvnSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AvnsCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AvnsCreationSpec</command:parameterValue> <dev:type> <maml:name>AvnsCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AvnsCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AvnsCreationSpec</command:parameterValue> <dev:type> <maml:name>AvnsCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Avn = Initialize-VcfAvn -Id "3f39d4a1-78d2-11e8-af85-f1cf26258cdc" -Name "vRealize-AVN" -RegionType "REGION_A" -Subnet "192.168.31.0" -SubnetMask "255.255.255.0" -Gateway "192.168.31.1" -Mtu 1600 -VlanId 30 -PortGroupName "sfo-m01-seg01-pg" -DomainName "rainpole.io" -RouterName "sfo-m01-ec01-t1-gw01" $AvnsCreationSpec = Initialize-VcfAvnsCreationSpec -EdgeClusterId "3f39d4a1-78d2-11e8-af85-f1cf26258cdc" -Avns $Avn Invoke-VcfValidateAvnSpec -avnsCreationSpec $avnsCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateAvnSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Avn = Initialize-VcfAvn -Name "vRealize-AVN" -RegionType "REGION_A" -Subnet "192.168.31.0" -SubnetMask "255.255.255.0" -Gateway "192.168.31.1" -Mtu 1600 $AvnsCreationSpec = Initialize-VcfAvnsCreationSpec -Avns $Avn Invoke-VcfValidateAvnSpec -avnsCreationSpec $avnsCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateAvnSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/avns/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfAvnsCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfAvnsCreationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>AvnsCreationSpec</command:noun> <maml:description> <maml:para>Provide the spec to create the AVNs</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Provide the spec to create the AVNs</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfAvnsCreationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterId</maml:name> <maml:Description> <maml:para>The UUID of the Edge Cluster to associate VLAN AVNs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Avns</maml:name> <maml:Description> <maml:para>The list of AVNs to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Avn></command:parameterValue> <dev:type> <maml:name>List<Avn></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterId</maml:name> <maml:Description> <maml:para>The UUID of the Edge Cluster to associate VLAN AVNs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Avns</maml:name> <maml:Description> <maml:para>The list of AVNs to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Avn></command:parameterValue> <dev:type> <maml:name>List<Avn></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Avn = Initialize-VcfAvn -Id "3f39d4a1-78d2-11e8-af85-f1cf26258cdc" -Name "vRealize-AVN" -RegionType "REGION_A" -Subnet "192.168.31.0" -SubnetMask "255.255.255.0" -Gateway "192.168.31.1" -Mtu 1600 -VlanId 30 -PortGroupName "sfo-m01-seg01-pg" -DomainName "rainpole.io" -RouterName "sfo-m01-ec01-t1-gw01" $AvnsCreationSpec = Initialize-VcfAvnsCreationSpec -EdgeClusterId "3f39d4a1-78d2-11e8-af85-f1cf26258cdc" -Avns $Avn </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAvnsCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Avn = Initialize-VcfAvn -Name "vRealize-AVN" -RegionType "REGION_A" -Subnet "192.168.31.0" -SubnetMask "255.255.255.0" -Gateway "192.168.31.1" -Mtu 1600 $AvnsCreationSpec = Initialize-VcfAvnsCreationSpec -Avns $Avn </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfAvnsCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/AvnsCreationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBackupConfigurationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>BackupConfigurationSpec</command:noun> <maml:description> <maml:para>Backup configuration Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Backup configuration Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBackupConfigurationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Encryption</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Encryption</command:parameterValue> <dev:type> <maml:name>Encryption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupLocations</maml:name> <maml:Description> <maml:para>List of backup locations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BackupLocation></command:parameterValue> <dev:type> <maml:name>List<BackupLocation></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupSchedules</maml:name> <maml:Description> <maml:para>List of backup schedules</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BackupSchedule></command:parameterValue> <dev:type> <maml:name>List<BackupSchedule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Encryption</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Encryption</command:parameterValue> <dev:type> <maml:name>Encryption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupLocations</maml:name> <maml:Description> <maml:para>List of backup locations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BackupLocation></command:parameterValue> <dev:type> <maml:name>List<BackupLocation></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupSchedules</maml:name> <maml:Description> <maml:para>List of backup schedules</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BackupSchedule></command:parameterValue> <dev:type> <maml:name>List<BackupSchedule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" $BackupLocation = Initialize-VcfBackupLocation -Server "MyServer" -Port 0 -Protocol "SFTP" -Username "MyUsername" -Password "MyPassword" -DirectoryPath "MyDirectoryPath" -SshFingerprint "MySshFingerprint" $BackupRetentionPolicy = Initialize-VcfBackupRetentionPolicy -NumberOfMostRecentBackups 15 -NumberOfDaysOfHourlyBackups 10 -NumberOfDaysOfDailyBackups 20 $BackupSchedule = Initialize-VcfBackupSchedule -ResourceType "SDDC_MANAGER" -TakeScheduledBackups $true -Frequency "One among: WEEKLY, HOURLY" -DaysOfWeek "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY" -HourOfDay 0 -MinuteOfHour 0 -TakeBackupOnStateChange $true -RetentionPolicy $BackupRetentionPolicy $BackupConfigurationSpec = Initialize-VcfBackupConfigurationSpec -Encryption $Encryption -BackupLocations $BackupLocation -BackupSchedules $BackupSchedule </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupConfigurationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BackupConfigurationSpec = Initialize-VcfBackupConfigurationSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupConfigurationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BackupConfigurationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEncryption</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBackupLocation</command:name> <command:verb>Initialize</command:verb> <command:noun>BackupLocation</command:noun> <maml:description> <maml:para>Backup location to backup VCF resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Backup location to backup VCF resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBackupLocation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>IP address or FQDN of the backup server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Port number for the backup server to connect</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Protocol</maml:name> <maml:Description> <maml:para>Protocol to be used for transferring files</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Backup server username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Backup server password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DirectoryPath</maml:name> <maml:Description> <maml:para>Full directory path to save the backup files</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshFingerprint</maml:name> <maml:Description> <maml:para>SSH fingerprint of the backup server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>IP address or FQDN of the backup server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Port number for the backup server to connect</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Protocol</maml:name> <maml:Description> <maml:para>Protocol to be used for transferring files</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Backup server username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Backup server password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DirectoryPath</maml:name> <maml:Description> <maml:para>Full directory path to save the backup files</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshFingerprint</maml:name> <maml:Description> <maml:para>SSH fingerprint of the backup server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BackupLocation = Initialize-VcfBackupLocation -Server "MyServer" -Port 0 -Protocol "SFTP" -Username "MyUsername" -Password "MyPassword" -DirectoryPath "MyDirectoryPath" -SshFingerprint "MySshFingerprint" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupLocation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BackupLocation = Initialize-VcfBackupLocation -Server "MyServer" -Port 0 -Protocol "SFTP" -Username "MyUsername" -DirectoryPath "MyDirectoryPath" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupLocation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BackupLocation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBackupResource</command:name> <command:verb>Initialize</command:verb> <command:noun>BackupResource</command:noun> <maml:description> <maml:para>Element specification to trigger backup</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Element specification to trigger backup</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBackupResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BackupResource</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetBackupConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetBackupConfiguration</command:noun> <maml:description> <maml:para>Retrieve the backup configuration for SDDC Manager and NSX Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetBackupConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BackupConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetBackupConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBackupConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetBackupConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBackupConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/backup-configuration/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetBackupLocation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetBackupLocation</command:noun> <maml:description> <maml:para>Retrieve the backup location details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetBackupLocation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServerIP</maml:name> <maml:Description> <maml:para>Backup server IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Backup server port</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServerIP</maml:name> <maml:Description> <maml:para>Backup server IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Backup server port</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BackupLocation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetBackupLocation -serverIP "MyserverIP" -port "Myport" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBackupLocation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetBackupLocation -serverIP "MyserverIP" -port "Myport" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBackupLocation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/backup-configuration/backup-locations/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetRestoreTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetRestoreTask</command:noun> <maml:description> <maml:para>Retrieve the restore task</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetRestoreTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The restore task ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The restore task ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetRestoreTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetRestoreTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetRestoreTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetRestoreTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/restores/tasks/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfSetBackupConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfSetBackupConfiguration</command:noun> <maml:description> <maml:para>Configure the backup configuration for SDDC Manager and NSX Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfSetBackupConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupConfigurationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupConfigurationSpec</command:parameterValue> <dev:type> <maml:name>BackupConfigurationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupConfigurationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupConfigurationSpec</command:parameterValue> <dev:type> <maml:name>BackupConfigurationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" $BackupLocation = Initialize-VcfBackupLocation -Server "MyServer" -Port 0 -Protocol "SFTP" -Username "MyUsername" -Password "MyPassword" -DirectoryPath "MyDirectoryPath" -SshFingerprint "MySshFingerprint" $BackupRetentionPolicy = Initialize-VcfBackupRetentionPolicy -NumberOfMostRecentBackups 15 -NumberOfDaysOfHourlyBackups 10 -NumberOfDaysOfDailyBackups 20 $BackupSchedule = Initialize-VcfBackupSchedule -ResourceType "SDDC_MANAGER" -TakeScheduledBackups $true -Frequency "One among: WEEKLY, HOURLY" -DaysOfWeek "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY" -HourOfDay 0 -MinuteOfHour 0 -TakeBackupOnStateChange $true -RetentionPolicy $BackupRetentionPolicy $BackupConfigurationSpec = Initialize-VcfBackupConfigurationSpec -Encryption $Encryption -BackupLocations $BackupLocation -BackupSchedules $BackupSchedule Invoke-VcfSetBackupConfiguration -backupConfigurationSpec $backupConfigurationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfSetBackupConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BackupConfigurationSpec = Initialize-VcfBackupConfigurationSpec Invoke-VcfSetBackupConfiguration -backupConfigurationSpec $backupConfigurationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfSetBackupConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/backup-configuration/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBackupConfigurationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartBackup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartBackup</command:noun> <maml:description> <maml:para>Start a backup operation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartBackup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupSpec</command:parameterValue> <dev:type> <maml:name>BackupSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupSpec</command:parameterValue> <dev:type> <maml:name>BackupSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BackupTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" $BackupSpec = Initialize-VcfBackupSpec -Elements $BackupResource Invoke-VcfStartBackup -backupSpec $backupSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartBackup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" $BackupSpec = Initialize-VcfBackupSpec -Elements $BackupResource Invoke-VcfStartBackup -backupSpec $backupSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartBackup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/backups/tasks/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBackupSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartRestore</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartRestore</command:noun> <maml:description> <maml:para>Start a restore operation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartRestore</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RestoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RestoreSpec</command:parameterValue> <dev:type> <maml:name>RestoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RestoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RestoreSpec</command:parameterValue> <dev:type> <maml:name>RestoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" $Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" $RestoreSpec = Initialize-VcfRestoreSpec -Elements $BackupResource -BackupFile "MyBackupFile" -Encryption $Encryption Invoke-VcfStartRestore -restoreSpec $restoreSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartRestore with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" $Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" $RestoreSpec = Initialize-VcfRestoreSpec -Elements $BackupResource -BackupFile "MyBackupFile" -Encryption $Encryption Invoke-VcfStartRestore -restoreSpec $restoreSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartRestore with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/restores/tasks/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfRestoreSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateBackupConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateBackupConfiguration</command:noun> <maml:description> <maml:para>Update the backup configuration for SDDC Manager and NSX Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateBackupConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupConfigurationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupConfigurationSpec</command:parameterValue> <dev:type> <maml:name>BackupConfigurationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupConfigurationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupConfigurationSpec</command:parameterValue> <dev:type> <maml:name>BackupConfigurationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" $BackupLocation = Initialize-VcfBackupLocation -Server "MyServer" -Port 0 -Protocol "SFTP" -Username "MyUsername" -Password "MyPassword" -DirectoryPath "MyDirectoryPath" -SshFingerprint "MySshFingerprint" $BackupRetentionPolicy = Initialize-VcfBackupRetentionPolicy -NumberOfMostRecentBackups 15 -NumberOfDaysOfHourlyBackups 10 -NumberOfDaysOfDailyBackups 20 $BackupSchedule = Initialize-VcfBackupSchedule -ResourceType "SDDC_MANAGER" -TakeScheduledBackups $true -Frequency "One among: WEEKLY, HOURLY" -DaysOfWeek "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY" -HourOfDay 0 -MinuteOfHour 0 -TakeBackupOnStateChange $true -RetentionPolicy $BackupRetentionPolicy $BackupConfigurationSpec = Initialize-VcfBackupConfigurationSpec -Encryption $Encryption -BackupLocations $BackupLocation -BackupSchedules $BackupSchedule Invoke-VcfUpdateBackupConfiguration -backupConfigurationSpec $backupConfigurationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateBackupConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BackupConfigurationSpec = Initialize-VcfBackupConfigurationSpec Invoke-VcfUpdateBackupConfiguration -backupConfigurationSpec $backupConfigurationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateBackupConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/backup-configuration/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBackupConfigurationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateBackupConfigurationsOperations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateBackupConfigurationsOperations</command:noun> <maml:description> <maml:para>Validation API for backup configuration for SDDC Manager and NSX Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateBackupConfigurationsOperations</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupConfigurationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupConfigurationSpec</command:parameterValue> <dev:type> <maml:name>BackupConfigurationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupConfigurationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupConfigurationSpec</command:parameterValue> <dev:type> <maml:name>BackupConfigurationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" $BackupLocation = Initialize-VcfBackupLocation -Server "MyServer" -Port 0 -Protocol "SFTP" -Username "MyUsername" -Password "MyPassword" -DirectoryPath "MyDirectoryPath" -SshFingerprint "MySshFingerprint" $BackupRetentionPolicy = Initialize-VcfBackupRetentionPolicy -NumberOfMostRecentBackups 15 -NumberOfDaysOfHourlyBackups 10 -NumberOfDaysOfDailyBackups 20 $BackupSchedule = Initialize-VcfBackupSchedule -ResourceType "SDDC_MANAGER" -TakeScheduledBackups $true -Frequency "One among: WEEKLY, HOURLY" -DaysOfWeek "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY" -HourOfDay 0 -MinuteOfHour 0 -TakeBackupOnStateChange $true -RetentionPolicy $BackupRetentionPolicy $BackupConfigurationSpec = Initialize-VcfBackupConfigurationSpec -Encryption $Encryption -BackupLocations $BackupLocation -BackupSchedules $BackupSchedule Invoke-VcfValidateBackupConfigurationsOperations -backupConfigurationSpec $backupConfigurationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateBackupConfigurationsOperations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BackupConfigurationSpec = Initialize-VcfBackupConfigurationSpec Invoke-VcfValidateBackupConfigurationsOperations -backupConfigurationSpec $backupConfigurationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateBackupConfigurationsOperations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/backup-configuration/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBackupConfigurationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBackupRetentionPolicy</command:name> <command:verb>Initialize</command:verb> <command:noun>BackupRetentionPolicy</command:noun> <maml:description> <maml:para>Backup retention policy for SDDC Manager comprising three attributes. Backup files are deleted if they do not satisfy any of the three attributes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Backup retention policy for SDDC Manager comprising three attributes. Backup files are deleted if they do not satisfy any of the three attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBackupRetentionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NumberOfMostRecentBackups</maml:name> <maml:Description> <maml:para>This attribute controls the number of recent backup files to retain. Range 1 to 600 backup files.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NumberOfDaysOfHourlyBackups</maml:name> <maml:Description> <maml:para>This attribute controls the number of hourly backup files to retain, measured in days. Range 0 to 14 days. The system will filter the existing backup files, and retain one for every hour for the specified number of days, counting back from the most recent backup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">uint?</command:parameterValue> <dev:type> <maml:name>uint?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NumberOfDaysOfDailyBackups</maml:name> <maml:Description> <maml:para>This attribute controls the number of daily backup files to retain, measured in days. Range 0 to 30 days. The system will filter the existing backup files, and retain one for every day for the specified number of days, counting back from the most recent backup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">uint?</command:parameterValue> <dev:type> <maml:name>uint?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NumberOfMostRecentBackups</maml:name> <maml:Description> <maml:para>This attribute controls the number of recent backup files to retain. Range 1 to 600 backup files.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NumberOfDaysOfHourlyBackups</maml:name> <maml:Description> <maml:para>This attribute controls the number of hourly backup files to retain, measured in days. Range 0 to 14 days. The system will filter the existing backup files, and retain one for every hour for the specified number of days, counting back from the most recent backup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">uint?</command:parameterValue> <dev:type> <maml:name>uint?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NumberOfDaysOfDailyBackups</maml:name> <maml:Description> <maml:para>This attribute controls the number of daily backup files to retain, measured in days. Range 0 to 30 days. The system will filter the existing backup files, and retain one for every day for the specified number of days, counting back from the most recent backup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">uint?</command:parameterValue> <dev:type> <maml:name>uint?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BackupRetentionPolicy = Initialize-VcfBackupRetentionPolicy -NumberOfMostRecentBackups 15 -NumberOfDaysOfHourlyBackups 10 -NumberOfDaysOfDailyBackups 20 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupRetentionPolicy with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BackupRetentionPolicy = Initialize-VcfBackupRetentionPolicy -NumberOfMostRecentBackups 15 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupRetentionPolicy with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BackupRetentionPolicy</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBackupSchedule</command:name> <command:verb>Initialize</command:verb> <command:noun>BackupSchedule</command:noun> <maml:description> <maml:para>Backup schedule configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Backup schedule configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBackupSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type to configure backup schedule</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TakeScheduledBackups</maml:name> <maml:Description> <maml:para>Enable/disable scheduled backups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Frequency</maml:name> <maml:Description> <maml:para>Backup frequency</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DaysOfWeek</maml:name> <maml:Description> <maml:para>List of days of the week to schedule backup</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HourOfDay</maml:name> <maml:Description> <maml:para>Hour of the day to schedule backup</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MinuteOfHour</maml:name> <maml:Description> <maml:para>Minute of the hour to schedule backup</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TakeBackupOnStateChange</maml:name> <maml:Description> <maml:para>Enable/disable backups on state change. If enabled, SDDC Manager will take a backup after the successful completion of an operation that changes its state. This mode requires that scheduled backups be enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetentionPolicy</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupRetentionPolicy</command:parameterValue> <dev:type> <maml:name>BackupRetentionPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type to configure backup schedule</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TakeScheduledBackups</maml:name> <maml:Description> <maml:para>Enable/disable scheduled backups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Frequency</maml:name> <maml:Description> <maml:para>Backup frequency</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DaysOfWeek</maml:name> <maml:Description> <maml:para>List of days of the week to schedule backup</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HourOfDay</maml:name> <maml:Description> <maml:para>Hour of the day to schedule backup</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MinuteOfHour</maml:name> <maml:Description> <maml:para>Minute of the hour to schedule backup</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TakeBackupOnStateChange</maml:name> <maml:Description> <maml:para>Enable/disable backups on state change. If enabled, SDDC Manager will take a backup after the successful completion of an operation that changes its state. This mode requires that scheduled backups be enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetentionPolicy</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupRetentionPolicy</command:parameterValue> <dev:type> <maml:name>BackupRetentionPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BackupRetentionPolicy = Initialize-VcfBackupRetentionPolicy -NumberOfMostRecentBackups 15 -NumberOfDaysOfHourlyBackups 10 -NumberOfDaysOfDailyBackups 20 $BackupSchedule = Initialize-VcfBackupSchedule -ResourceType "SDDC_MANAGER" -TakeScheduledBackups $true -Frequency "One among: WEEKLY, HOURLY" -DaysOfWeek "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY" -HourOfDay 0 -MinuteOfHour 0 -TakeBackupOnStateChange $true -RetentionPolicy $BackupRetentionPolicy </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupSchedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BackupSchedule = Initialize-VcfBackupSchedule -ResourceType "SDDC_MANAGER" -Frequency "One among: WEEKLY, HOURLY" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupSchedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BackupSchedule</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBackupRetentionPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBackupSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>BackupSpec</command:noun> <maml:description> <maml:para>Backup Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Backup Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBackupSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>List of elements to be backed up</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BackupResource></command:parameterValue> <dev:type> <maml:name>List<BackupResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>List of elements to be backed up</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BackupResource></command:parameterValue> <dev:type> <maml:name>List<BackupResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" $BackupSpec = Initialize-VcfBackupSpec -Elements $BackupResource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" $BackupSpec = Initialize-VcfBackupSpec -Elements $BackupResource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBackupSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BackupSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBaseAlias</command:name> <command:verb>Initialize</command:verb> <command:noun>BaseAlias</command:noun> <maml:description> <maml:para>Base Alias representation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Base Alias representation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBaseAlias</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Base version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Aliases</maml:name> <maml:Description> <maml:para>List of Alias versions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Base version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Aliases</maml:name> <maml:Description> <maml:para>List of Alias versions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BaseAlias = Initialize-VcfBaseAlias -_Version "My_Version" -Aliases "MyAliases" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBaseAlias with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BaseAlias = Initialize-VcfBaseAlias -_Version "My_Version" -Aliases "MyAliases" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBaseAlias with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BaseAlias</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBaseCredential</command:name> <command:verb>Initialize</command:verb> <command:noun>BaseCredential</command:noun> <maml:description> <maml:para>Represents credentials of a resource in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents credentials of a resource in the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBaseCredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialType</maml:name> <maml:Description> <maml:para>Credential type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AccountType</maml:name> <maml:Description> <maml:para>Account type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialType</maml:name> <maml:Description> <maml:para>Credential type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AccountType</maml:name> <maml:Description> <maml:para>Account type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BaseCredential = Initialize-VcfBaseCredential -CredentialType "One among: SSO, SSH, API, FTP, AUDIT" -AccountType "One among: USER, SYSTEM, SERVICE" -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBaseCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BaseCredential = Initialize-VcfBaseCredential -Username "MyUsername" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBaseCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BaseCredential</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBaseImageDetails</command:name> <command:verb>Initialize</command:verb> <command:noun>BaseImageDetails</command:noun> <maml:description> <maml:para>BaseImage contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>BaseImage contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBaseImageDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>BaseImage display name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayVersion</maml:name> <maml:Description> <maml:para>BaseImage display version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>BaseImage release date</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseTimestamp</maml:name> <maml:Description> <maml:para>Timestamp of BaseImage release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QuickPatchCompatibleVersions</maml:name> <maml:Description> <maml:para>ESX Quick Patch compatible source image versions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ModelVersion></command:parameterValue> <dev:type> <maml:name>List<ModelVersion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>BaseImage display name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayVersion</maml:name> <maml:Description> <maml:para>BaseImage display version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>BaseImage release date</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseTimestamp</maml:name> <maml:Description> <maml:para>Timestamp of BaseImage release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QuickPatchCompatibleVersions</maml:name> <maml:Description> <maml:para>ESX Quick Patch compatible source image versions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ModelVersion></command:parameterValue> <dev:type> <maml:name>List<ModelVersion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ModelVersion = Initialize-VcfModelVersion -_Version "8.0.3-0.0.23174786" -DisplayVersion "8.0 Update 3 - 23174786" $BaseImageDetails = Initialize-VcfBaseImageDetails -DisplayName "7.0.0-0.0.30340198" -DisplayVersion "MyDisplayVersion" -ReleaseDate "MyReleaseDate" -ReleaseTimestamp "MyReleaseTimestamp" -QuickPatchCompatibleVersions $ModelVersion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBaseImageDetails with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BaseImageDetails = Initialize-VcfBaseImageDetails -DisplayName "7.0.0-0.0.30340198" -DisplayVersion "MyDisplayVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBaseImageDetails with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BaseImageDetails</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBaseImageInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>BaseImageInfo</command:noun> <maml:description> <maml:para>BaseImage contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>BaseImage contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBaseImageInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>BaseImage Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Details</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BaseImageDetails</command:parameterValue> <dev:type> <maml:name>BaseImageDetails</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>BaseImage Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Details</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BaseImageDetails</command:parameterValue> <dev:type> <maml:name>BaseImageDetails</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ModelVersion = Initialize-VcfModelVersion -_Version "8.0.3-0.0.23174786" -DisplayVersion "8.0 Update 3 - 23174786" $BaseImageDetails = Initialize-VcfBaseImageDetails -DisplayName "7.0.0-0.0.30340198" -DisplayVersion "MyDisplayVersion" -ReleaseDate "MyReleaseDate" -ReleaseTimestamp "MyReleaseTimestamp" -QuickPatchCompatibleVersions $ModelVersion $BaseImageInfo = Initialize-VcfBaseImageInfo -_Version "7.0.0-0.0.30340198" -Details $BaseImageDetails </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBaseImageInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BaseImageInfo = Initialize-VcfBaseImageInfo -_Version "7.0.0-0.0.30340198" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBaseImageInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BaseImageInfo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBaseImageDetails</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBgpPeerSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>BgpPeerSpec</command:noun> <maml:description> <maml:para>This specification contains configuration inputs required for BGP configuration for an uplink</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains configuration inputs required for BGP configuration for an uplink</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBgpPeerSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Ip</maml:name> <maml:Description> <maml:para>BGP Peer IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Asn</maml:name> <maml:Description> <maml:para>ASN of Peer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>BGP Peer Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Ip</maml:name> <maml:Description> <maml:para>BGP Peer IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Asn</maml:name> <maml:Description> <maml:para>ASN of Peer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>BGP Peer Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBgpPeerSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBgpPeerSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BgpPeerSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBundleDownloadSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>BundleDownloadSpec</command:noun> <maml:description> <maml:para>Bundle Download Specification. This specification gets used in the Bundle Download API</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Bundle Download Specification. This specification gets used in the Bundle Download API</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBundleDownloadSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ScheduledTimestamp</maml:name> <maml:Description> <maml:para>Bundle Download Scheduled Time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DownloadNow</maml:name> <maml:Description> <maml:para>Flag for enabling Download Now. If true, scheduledTimestamp is ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CancelNow</maml:name> <maml:Description> <maml:para>Flag for cancelling the download. If true, scheduledTimestamp/downloadNow is ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ScheduledTimestamp</maml:name> <maml:Description> <maml:para>Bundle Download Scheduled Time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DownloadNow</maml:name> <maml:Description> <maml:para>Flag for enabling Download Now. If true, scheduledTimestamp is ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CancelNow</maml:name> <maml:Description> <maml:para>Flag for cancelling the download. If true, scheduledTimestamp/downloadNow is ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BundleDownloadSpec = Initialize-VcfBundleDownloadSpec -ScheduledTimestamp "MyScheduledTimestamp" -DownloadNow $false -CancelNow $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleDownloadSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BundleDownloadSpec = Initialize-VcfBundleDownloadSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleDownloadSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BundleDownloadSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBundleInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>BundleInfo</command:noun> <maml:description> <maml:para>Patch/Install bundle info to be used as part of ProductVersionCatalog patches.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Patch/Install bundle info to be used as part of ProductVersionCatalog patches.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBundleInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Bundle id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Type of bundle. ex) PATCH, INSTALL</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Patch/Install bundle name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Bundle id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Type of bundle. ex) PATCH, INSTALL</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Patch/Install bundle name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BundleInfo = Initialize-VcfBundleInfo -Id "MyId" -Type "MyType" -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BundleInfo = Initialize-VcfBundleInfo -Id "MyId" -Type "MyType" -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BundleInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBundleRecall</command:name> <command:verb>Initialize</command:verb> <command:noun>BundleRecall</command:noun> <maml:description> <maml:para>Bundle Recall model for collection of bundles that are recalled with their replacements if applicable.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Bundle Recall model for collection of bundles that are recalled with their replacements if applicable.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBundleRecall</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RecalledBundleIds</maml:name> <maml:Description> <maml:para>List of Bundle IDs that are recalled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReplacementBundleStatus</maml:name> <maml:Description> <maml:para>Status of bundle replacement.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReplacementBundleIds</maml:name> <maml:Description> <maml:para>List of Bundle IDs that act as replacement</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RecalledBundleIds</maml:name> <maml:Description> <maml:para>List of Bundle IDs that are recalled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReplacementBundleStatus</maml:name> <maml:Description> <maml:para>Status of bundle replacement.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReplacementBundleIds</maml:name> <maml:Description> <maml:para>List of Bundle IDs that act as replacement</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BundleRecall = Initialize-VcfBundleRecall -RecalledBundleIds "MyRecalledBundleIds" -ReplacementBundleStatus "One among: NONE, PENDING, READY" -ReplacementBundleIds "MyReplacementBundleIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleRecall with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BundleRecall = Initialize-VcfBundleRecall -RecalledBundleIds "MyRecalledBundleIds" -ReplacementBundleStatus "One among: NONE, PENDING, READY" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleRecall with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BundleRecall</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteBundle</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteBundle</command:noun> <maml:description> <maml:para>Delete a bundle by bundle ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a Bundle by bundle ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteBundle</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteBundle -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteBundle with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteBundle -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteBundle with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/bundles/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetBundle</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetBundle</command:noun> <maml:description> <maml:para>Retrieve a bundle by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Bundle</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetBundle</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Bundle</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetBundle -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBundle with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetBundle -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBundle with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/bundles/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetBundles</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetBundles</command:noun> <maml:description> <maml:para>Retrieve a list of bundles</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all Bundles i.e uploaded bundles and also bundles available via depot access.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetBundles</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>The type of the product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsCompliant</maml:name> <maml:Description> <maml:para>Is compliant with the current VCF version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleType</maml:name> <maml:Description> <maml:para>The type of the bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>The type of the product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsCompliant</maml:name> <maml:Description> <maml:para>Is compliant with the current VCF version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleType</maml:name> <maml:Description> <maml:para>The type of the bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfBundle</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetBundles -productType VRA,VROPS,VRLI -isCompliant $true -bundleType "MybundleType" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBundles with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetBundles </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBundles with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/bundles/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetBundlesForSkipUpgrade</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetBundlesForSkipUpgrade</command:noun> <maml:description> <maml:para>Retrieve a list of bundles for skip upgrade by domain ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get bundles for skip upgrade a domain from current version to target version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetBundlesForSkipUpgrade</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVersion</maml:name> <maml:Description> <maml:para>[Deprecated] Target domain VCF version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVersion</maml:name> <maml:Description> <maml:para>[Deprecated] Target domain VCF version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfBundle</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetBundlesForSkipUpgrade -id "Myid" -targetVersion "MytargetVersion" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBundlesForSkipUpgrade with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetBundlesForSkipUpgrade -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetBundlesForSkipUpgrade with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/bundles/domains/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartBundleDownloadByID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartBundleDownloadByID</command:noun> <maml:description> <maml:para>Start immediate download or schedule download of a bundle by ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Bundle for scheduling/triggering download. Only one download can triggered for a Bundle.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartBundleDownloadByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BundleUpdateSpec</command:parameterValue> <dev:type> <maml:name>BundleUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BundleUpdateSpec</command:parameterValue> <dev:type> <maml:name>BundleUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BundleDownloadSpec = Initialize-VcfBundleDownloadSpec -ScheduledTimestamp "MyScheduledTimestamp" -DownloadNow $false -CancelNow $false $BundleUpdateSpec = Initialize-VcfBundleUpdateSpec -BundleDownloadSpec $BundleDownloadSpec -CompatibilitySetsFilePath "MyCompatibilitySetsFilePath" Invoke-VcfStartBundleDownloadByID -id "Myid" -bundleUpdateSpec $bundleUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartBundleDownloadByID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BundleUpdateSpec = Initialize-VcfBundleUpdateSpec Invoke-VcfStartBundleDownloadByID -id "Myid" -bundleUpdateSpec $bundleUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartBundleDownloadByID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/bundles/id/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBundleUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateBundleCompatibilitySets</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateBundleCompatibilitySets</command:noun> <maml:description> <maml:para>Update the software compatability set for all bundles</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update software compatibility sets for Bundles</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateBundleCompatibilitySets</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BundleUpdateSpec</command:parameterValue> <dev:type> <maml:name>BundleUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BundleUpdateSpec</command:parameterValue> <dev:type> <maml:name>BundleUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BundleDownloadSpec = Initialize-VcfBundleDownloadSpec -ScheduledTimestamp "MyScheduledTimestamp" -DownloadNow $false -CancelNow $false $BundleUpdateSpec = Initialize-VcfBundleUpdateSpec -BundleDownloadSpec $BundleDownloadSpec -CompatibilitySetsFilePath "MyCompatibilitySetsFilePath" Invoke-VcfUpdateBundleCompatibilitySets -bundleUpdateSpec $bundleUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateBundleCompatibilitySets with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BundleUpdateSpec = Initialize-VcfBundleUpdateSpec Invoke-VcfUpdateBundleCompatibilitySets -bundleUpdateSpec $bundleUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateBundleCompatibilitySets with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/bundles//patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBundleUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUploadBundle</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUploadBundle</command:noun> <maml:description> <maml:para>Upload a bundle to SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upload Bundle to SDDC Manager. Used when you do not have internet connectivity for downloading bundles from VMWare/VxRail to SDDC Manager. The Bundles are manually downloaded from Depot using Bundle Transfer utility</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUploadBundle</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleUploadSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BundleUploadSpec</command:parameterValue> <dev:type> <maml:name>BundleUploadSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleUploadSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BundleUploadSpec</command:parameterValue> <dev:type> <maml:name>BundleUploadSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PartnerExtensionSpec = Initialize-VcfPartnerExtensionSpec -PartnerBundleVersion "MyPartnerBundleVersion" -PartnerBundleMetadataFilePath "MyPartnerBundleMetadataFilePath" $BundleUploadSpec = Initialize-VcfBundleUploadSpec -BundleFilePath "MyBundleFilePath" -ManifestFilePath "MyManifestFilePath" -SignatureFilePath "MySignatureFilePath" -CompatibilitySetsFilePath "MyCompatibilitySetsFilePath" -PartnerExtensionSpec $PartnerExtensionSpec Invoke-VcfUploadBundle -bundleUploadSpec $bundleUploadSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadBundle with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BundleUploadSpec = Initialize-VcfBundleUploadSpec -BundleFilePath "MyBundleFilePath" -ManifestFilePath "MyManifestFilePath" Invoke-VcfUploadBundle -bundleUploadSpec $bundleUploadSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadBundle with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/bundles/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBundleUploadSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBundleUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>BundleUpdateSpec</command:noun> <maml:description> <maml:para>Bundle Update Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Bundle Update Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBundleUpdateSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleDownloadSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BundleDownloadSpec</command:parameterValue> <dev:type> <maml:name>BundleDownloadSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilitySetsFilePath</maml:name> <maml:Description> <maml:para>[Deprecated] Path to the software compatibility sets file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleDownloadSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BundleDownloadSpec</command:parameterValue> <dev:type> <maml:name>BundleDownloadSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilitySetsFilePath</maml:name> <maml:Description> <maml:para>[Deprecated] Path to the software compatibility sets file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BundleDownloadSpec = Initialize-VcfBundleDownloadSpec -ScheduledTimestamp "MyScheduledTimestamp" -DownloadNow $false -CancelNow $false $BundleUpdateSpec = Initialize-VcfBundleUpdateSpec -BundleDownloadSpec $BundleDownloadSpec -CompatibilitySetsFilePath "MyCompatibilitySetsFilePath" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BundleUpdateSpec = Initialize-VcfBundleUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BundleUpdateSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBundleDownloadSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfBundleUploadSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>BundleUploadSpec</command:noun> <maml:description> <maml:para>Bundle Upload Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Bundle Upload Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfBundleUploadSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleFilePath</maml:name> <maml:Description> <maml:para>Bundle Upload File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ManifestFilePath</maml:name> <maml:Description> <maml:para>Bundle Upload Manifest File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SignatureFilePath</maml:name> <maml:Description> <maml:para>Bundle Upload Signature File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilitySetsFilePath</maml:name> <maml:Description> <maml:para>[Deprecated] Path to the software compatibility sets file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PartnerExtensionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PartnerExtensionSpec</command:parameterValue> <dev:type> <maml:name>PartnerExtensionSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleFilePath</maml:name> <maml:Description> <maml:para>Bundle Upload File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ManifestFilePath</maml:name> <maml:Description> <maml:para>Bundle Upload Manifest File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SignatureFilePath</maml:name> <maml:Description> <maml:para>Bundle Upload Signature File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilitySetsFilePath</maml:name> <maml:Description> <maml:para>[Deprecated] Path to the software compatibility sets file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PartnerExtensionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PartnerExtensionSpec</command:parameterValue> <dev:type> <maml:name>PartnerExtensionSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PartnerExtensionSpec = Initialize-VcfPartnerExtensionSpec -PartnerBundleVersion "MyPartnerBundleVersion" -PartnerBundleMetadataFilePath "MyPartnerBundleMetadataFilePath" $BundleUploadSpec = Initialize-VcfBundleUploadSpec -BundleFilePath "MyBundleFilePath" -ManifestFilePath "MyManifestFilePath" -SignatureFilePath "MySignatureFilePath" -CompatibilitySetsFilePath "MyCompatibilitySetsFilePath" -PartnerExtensionSpec $PartnerExtensionSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleUploadSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BundleUploadSpec = Initialize-VcfBundleUploadSpec -BundleFilePath "MyBundleFilePath" -ManifestFilePath "MyManifestFilePath" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfBundleUploadSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/BundleUploadSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfPartnerExtensionSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCeipStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCeipStatus</command:noun> <maml:description> <maml:para>Retrieve the CEIP status</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get CEIP status and instance id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCeipStatus</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Ceip</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCeipStatus </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCeipStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCeipStatus </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCeipStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/ceip/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfSetCeipStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfSetCeipStatus</command:noun> <maml:description> <maml:para>Configure CEIP to Opt-In or Opt-Out</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opt-in or Opt-out of CEIP</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfSetCeipStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfSetCeipStatus -body "Mybody" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfSetCeipStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfSetCeipStatus -body "Mybody" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfSetCeipStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/ceip/patch/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCertificateAuthorityCreationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>CertificateAuthorityCreationSpec</command:noun> <maml:description> <maml:para>This specification contains Certificate Authority (CA) creation details. Either openSSLCertificateAuthoritySpec or microsoftCertificateAuthoritySpec should be specified.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains Certificate Authority (CA) creation details. Either openSSLCertificateAuthoritySpec or microsoftCertificateAuthoritySpec should be specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCertificateAuthorityCreationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OpenSSLCertificateAuthoritySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OpenSSLCertificateAuthoritySpec</command:parameterValue> <dev:type> <maml:name>OpenSSLCertificateAuthoritySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MicrosoftCertificateAuthoritySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MicrosoftCertificateAuthoritySpec</command:parameterValue> <dev:type> <maml:name>MicrosoftCertificateAuthoritySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OpenSSLCertificateAuthoritySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OpenSSLCertificateAuthoritySpec</command:parameterValue> <dev:type> <maml:name>OpenSSLCertificateAuthoritySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MicrosoftCertificateAuthoritySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MicrosoftCertificateAuthoritySpec</command:parameterValue> <dev:type> <maml:name>MicrosoftCertificateAuthoritySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $OpenSSLCertificateAuthoritySpec = Initialize-VcfOpenSSLCertificateAuthoritySpec -CommonName "OpenSSL CA" -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" $MicrosoftCertificateAuthoritySpec = Initialize-VcfMicrosoftCertificateAuthoritySpec -Username "Administrator" -Secret "********" -ServerUrl "https://sfo-ad.rainpole.io/certsrv" -TemplateName "WebServer" $CertificateAuthorityCreationSpec = Initialize-VcfCertificateAuthorityCreationSpec -OpenSSLCertificateAuthoritySpec $OpenSSLCertificateAuthoritySpec -MicrosoftCertificateAuthoritySpec $MicrosoftCertificateAuthoritySpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCertificateAuthorityCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CertificateAuthorityCreationSpec = Initialize-VcfCertificateAuthorityCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCertificateAuthorityCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CertificateAuthorityCreationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpenSSLCertificateAuthoritySpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfMicrosoftCertificateAuthoritySpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCertificateOperationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>CertificateOperationSpec</command:noun> <maml:description> <maml:para>This specification contains certificate operation request details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains certificate operation request details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCertificateOperationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationType</maml:name> <maml:Description> <maml:para>The Certificates operation type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Resource(s) in a domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Resource></command:parameterValue> <dev:type> <maml:name>List<Resource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationType</maml:name> <maml:Description> <maml:para>The Certificates operation type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Resource(s) in a domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Resource></command:parameterValue> <dev:type> <maml:name>List<Resource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Fqdn "sfo-vc01.rainpole.io" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" -Name "MyName" -Sans "sfo-vc01.rainpole.io" $CertificateOperationSpec = Initialize-VcfCertificateOperationSpec -OperationType "One among: INSTALL" -Resources $Resource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCertificateOperationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CertificateOperationSpec = Initialize-VcfCertificateOperationSpec -OperationType "One among: INSTALL" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCertificateOperationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CertificateOperationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfConfigureCertificateAuthority</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfConfigureCertificateAuthority</command:noun> <maml:description> <maml:para>Update the configuration of a Certificate Authority</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the configuration of a Certificate Authority</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfConfigureCertificateAuthority</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateAuthorityCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CertificateAuthorityCreationSpec</command:parameterValue> <dev:type> <maml:name>CertificateAuthorityCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateAuthorityCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CertificateAuthorityCreationSpec</command:parameterValue> <dev:type> <maml:name>CertificateAuthorityCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$OpenSSLCertificateAuthoritySpec = Initialize-VcfOpenSSLCertificateAuthoritySpec -CommonName "OpenSSL CA" -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" $MicrosoftCertificateAuthoritySpec = Initialize-VcfMicrosoftCertificateAuthoritySpec -Username "Administrator" -Secret "********" -ServerUrl "https://sfo-ad.rainpole.io/certsrv" -TemplateName "WebServer" $CertificateAuthorityCreationSpec = Initialize-VcfCertificateAuthorityCreationSpec -OpenSSLCertificateAuthoritySpec $OpenSSLCertificateAuthoritySpec -MicrosoftCertificateAuthoritySpec $MicrosoftCertificateAuthoritySpec Invoke-VcfConfigureCertificateAuthority -certificateAuthorityCreationSpec $certificateAuthorityCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConfigureCertificateAuthority with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CertificateAuthorityCreationSpec = Initialize-VcfCertificateAuthorityCreationSpec Invoke-VcfConfigureCertificateAuthority -certificateAuthorityCreationSpec $certificateAuthorityCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConfigureCertificateAuthority with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/certificate-authorities/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCertificateAuthorityCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCreateCertificateAuthority</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCreateCertificateAuthority</command:noun> <maml:description> <maml:para>Configure integration with a Certificate Authority</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a certificate authority. This is required to generate signed certificates by supporting CAs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCreateCertificateAuthority</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateAuthorityCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CertificateAuthorityCreationSpec</command:parameterValue> <dev:type> <maml:name>CertificateAuthorityCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateAuthorityCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CertificateAuthorityCreationSpec</command:parameterValue> <dev:type> <maml:name>CertificateAuthorityCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$OpenSSLCertificateAuthoritySpec = Initialize-VcfOpenSSLCertificateAuthoritySpec -CommonName "OpenSSL CA" -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" $MicrosoftCertificateAuthoritySpec = Initialize-VcfMicrosoftCertificateAuthoritySpec -Username "Administrator" -Secret "********" -ServerUrl "https://sfo-ad.rainpole.io/certsrv" -TemplateName "WebServer" $CertificateAuthorityCreationSpec = Initialize-VcfCertificateAuthorityCreationSpec -OpenSSLCertificateAuthoritySpec $OpenSSLCertificateAuthoritySpec -MicrosoftCertificateAuthoritySpec $MicrosoftCertificateAuthoritySpec Invoke-VcfCreateCertificateAuthority -certificateAuthorityCreationSpec $certificateAuthorityCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateCertificateAuthority with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CertificateAuthorityCreationSpec = Initialize-VcfCertificateAuthorityCreationSpec Invoke-VcfCreateCertificateAuthority -certificateAuthorityCreationSpec $certificateAuthorityCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateCertificateAuthority with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/certificate-authorities/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCertificateAuthorityCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDownloadCSR</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDownloadCSR</command:noun> <maml:description> <maml:para>Request the download of CSR(s) for a domain in tar.gz format</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Download available CSR(s) in tar.gz format</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDownloadCSR</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>byte[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDownloadCSR -id 3E86FBAD-8984-4D4B-992D-F0C49857572A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDownloadCSR with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDownloadCSR -id 3E86FBAD-8984-4D4B-992D-F0C49857572A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDownloadCSR with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/csrs/downloads/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGenerateCertificates</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGenerateCertificates</command:noun> <maml:description> <maml:para>Request the creation of signed certificate for resources of a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generate certificate(s) for the selected resource(s) in a domain. CA must be configured and CSR must be generated beforehand.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGenerateCertificates</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificatesGenerationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CertificatesGenerationSpec</command:parameterValue> <dev:type> <maml:name>CertificatesGenerationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificatesGenerationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CertificatesGenerationSpec</command:parameterValue> <dev:type> <maml:name>CertificatesGenerationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Fqdn "sfo-vc01.rainpole.io" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" -Name "MyName" -Sans "sfo-vc01.rainpole.io" $CertificatesGenerationSpec = Initialize-VcfCertificatesGenerationSpec -CaType "One among: OpenSSL, Microsoft" -Resources $Resource Invoke-VcfGenerateCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -certificatesGenerationSpec $certificatesGenerationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGenerateCertificates with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CertificatesGenerationSpec = Initialize-VcfCertificatesGenerationSpec -CaType "One among: OpenSSL, Microsoft" Invoke-VcfGenerateCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -certificatesGenerationSpec $certificatesGenerationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGenerateCertificates with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/certificates/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCertificatesGenerationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGeneratesCSRs</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGeneratesCSRs</command:noun> <maml:description> <maml:para>Request the creation of certificate signing request (CSR) files for resources of a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generate CSR(s) for the selected resource(s) in the domain. *Warning:* _Avoid using wildcard certificates. Instead, use subdomain-specific certificates that are rotated often. A compromised wildcard certificate can lead to security repercussions_</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGeneratesCSRs</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CsrsGenerationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CsrsGenerationSpec</command:parameterValue> <dev:type> <maml:name>CsrsGenerationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CsrsGenerationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CsrsGenerationSpec</command:parameterValue> <dev:type> <maml:name>CsrsGenerationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CsrGenerationSpec = Initialize-VcfCsrGenerationSpec -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" -Email "admin@vmware.com" -KeySize "One among: 2048, 3072, 4096" -KeyAlgorithm "One among: RSA" $Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Fqdn "sfo-vc01.rainpole.io" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" -Name "MyName" -Sans "sfo-vc01.rainpole.io" $CsrsGenerationSpec = Initialize-VcfCsrsGenerationSpec -CsrGenerationSpec $CsrGenerationSpec -Resources $Resource Invoke-VcfGeneratesCSRs -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -csrsGenerationSpec $csrsGenerationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGeneratesCSRs with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CsrGenerationSpec = Initialize-VcfCsrGenerationSpec -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" -KeySize "One among: 2048, 3072, 4096" -KeyAlgorithm "One among: RSA" $CsrsGenerationSpec = Initialize-VcfCsrsGenerationSpec -CsrGenerationSpec $CsrGenerationSpec Invoke-VcfGeneratesCSRs -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -csrsGenerationSpec $csrsGenerationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGeneratesCSRs with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/csrs/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCsrsGenerationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCSRs</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCSRs</command:noun> <maml:description> <maml:para>Request available CSR(s) in JSON format for a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get available CSR(s) in json format</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCSRs</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCsr</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCSRs -id 3E86FBAD-8984-4D4B-992D-F0C49857572A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCSRs with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCSRs -id 3E86FBAD-8984-4D4B-992D-F0C49857572A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCSRs with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/csrs/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCertificateAuthorities</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCertificateAuthorities</command:noun> <maml:description> <maml:para>Retrieve a list of Certificate Authorities</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get certificate authorities information</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCertificateAuthorities</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCertificateAuthority</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCertificateAuthorities </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCertificateAuthorities with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCertificateAuthorities </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCertificateAuthorities with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/certificate-authorities/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCertificateAuthorityById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCertificateAuthorityById</command:noun> <maml:description> <maml:para>Retrieve the details of a Certificate Authority by ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get certificate authority information</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCertificateAuthorityById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The CA type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The CA type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CertificateAuthority</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCertificateAuthorityById -id One among: OpenSSL, Microsoft </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCertificateAuthorityById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCertificateAuthorityById -id One among: OpenSSL, Microsoft </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCertificateAuthorityById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/certificate-authorities/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCertificatesByDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCertificatesByDomain</command:noun> <maml:description> <maml:para>Retrieve the certificate details for all resources in a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>View detailed metadata about the certificate(s) of all the resources in a domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCertificatesByDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCertificate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCertificatesByDomain -id 3E86FBAD-8984-4D4B-992D-F0C49857572A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCertificatesByDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCertificatesByDomain -id 3E86FBAD-8984-4D4B-992D-F0C49857572A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCertificatesByDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/resource-certificates/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDomainCertificates</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDomainCertificates</command:noun> <maml:description> <maml:para>Retrieve the latest generated certificates for a domain by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get latest generated certificate(s) in a domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDomainCertificates</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCertificate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainCertificates with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainCertificates with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/certificates/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetResourceCertificatesValidationByID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetResourceCertificatesValidationByID</command:noun> <maml:description> <maml:para>Retrieve the results of a certificate validation by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the resource certificate validation result</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetResourceCertificatesValidationByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ValidationId</maml:name> <maml:Description> <maml:para>Validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ValidationId</maml:name> <maml:Description> <maml:para>Validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCertificate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourceCertificatesValidationByID -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -validationId B1930850-7D1A-4BAA-89D7-52FD5DAD196A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourceCertificatesValidationByID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourceCertificatesValidationByID -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -validationId B1930850-7D1A-4BAA-89D7-52FD5DAD196A </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourceCertificatesValidationByID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/resource-certificates/validations/validationid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRemoveCertificateAuthority</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRemoveCertificateAuthority</command:noun> <maml:description> <maml:para>Remove the configuration of a Certificate Authority</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes CA configuration file</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRemoveCertificateAuthority</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The CA type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The CA type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveCertificateAuthority -id One among: OpenSSL, Microsoft </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveCertificateAuthority with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveCertificateAuthority -id One among: OpenSSL, Microsoft </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveCertificateAuthority with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/certificate-authorities/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfReplaceCertificates</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfReplaceCertificates</command:noun> <maml:description> <maml:para>Replace certificate(s) for the selected resource(s) in a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Replace certificate(s) for the selected resource(s) in a domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfReplaceCertificates</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateOperationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CertificateOperationSpec</command:parameterValue> <dev:type> <maml:name>CertificateOperationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateOperationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CertificateOperationSpec</command:parameterValue> <dev:type> <maml:name>CertificateOperationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Fqdn "sfo-vc01.rainpole.io" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" -Name "MyName" -Sans "sfo-vc01.rainpole.io" $CertificateOperationSpec = Initialize-VcfCertificateOperationSpec -OperationType "One among: INSTALL" -Resources $Resource Invoke-VcfReplaceCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -certificateOperationSpec $certificateOperationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfReplaceCertificates with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CertificateOperationSpec = Initialize-VcfCertificateOperationSpec -OperationType "One among: INSTALL" Invoke-VcfReplaceCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -certificateOperationSpec $certificateOperationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfReplaceCertificates with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/certificates/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCertificateOperationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfReplaceResourceCertificates</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfReplaceResourceCertificates</command:noun> <maml:description> <maml:para>Replace the certificate(s) for selected resources of a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Replace resource certificates</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfReplaceResourceCertificates</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCertificateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceCertificateSpec></command:parameterValue> <dev:type> <maml:name>List<ResourceCertificateSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCertificateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceCertificateSpec></command:parameterValue> <dev:type> <maml:name>List<ResourceCertificateSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceCertificateSpec = Initialize-VcfResourceCertificateSpec -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -ResourceFqdn "sfo-vc01.rainpole.io" -ResourceCertificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" -CaCertificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" -CertificateChain "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" Invoke-VcfReplaceResourceCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -resourceCertificateSpec $resourceCertificateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfReplaceResourceCertificates with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceCertificateSpec = Initialize-VcfResourceCertificateSpec Invoke-VcfReplaceResourceCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -resourceCertificateSpec $resourceCertificateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfReplaceResourceCertificates with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/resource-certificates/put/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUploadCertificates</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUploadCertificates</command:noun> <maml:description> <maml:para>Import certificate(s) to the certificate store for a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upload certificates to the certificate store</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUploadCertificates</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>File</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID or Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>File</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfUploadCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -file </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadCertificates with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfUploadCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -file </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadCertificates with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/certificates/uploads/put/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateResourceCertificates</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateResourceCertificates</command:noun> <maml:description> <maml:para>Perform validation of the ResourceCertificateSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Validate resource certificates</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateResourceCertificates</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCertificateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceCertificateSpec></command:parameterValue> <dev:type> <maml:name>List<ResourceCertificateSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCertificateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceCertificateSpec></command:parameterValue> <dev:type> <maml:name>List<ResourceCertificateSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CertificateValidationTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceCertificateSpec = Initialize-VcfResourceCertificateSpec -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -ResourceFqdn "sfo-vc01.rainpole.io" -ResourceCertificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" -CaCertificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" -CertificateChain "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" Invoke-VcfValidateResourceCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -resourceCertificateSpec $resourceCertificateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateResourceCertificates with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceCertificateSpec = Initialize-VcfResourceCertificateSpec Invoke-VcfValidateResourceCertificates -id 3E86FBAD-8984-4D4B-992D-F0C49857572A -resourceCertificateSpec $resourceCertificateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateResourceCertificates with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/resource-certificates/validations/put/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCertificatesGenerationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>CertificatesGenerationSpec</command:noun> <maml:description> <maml:para>This specification contains certificates generation request details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains certificates generation request details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCertificatesGenerationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CaType</maml:name> <maml:Description> <maml:para>CA type. Only supports Microsoft and OpenSSL CAs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Resource(s) in a domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Resource></command:parameterValue> <dev:type> <maml:name>List<Resource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CaType</maml:name> <maml:Description> <maml:para>CA type. Only supports Microsoft and OpenSSL CAs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Resource(s) in a domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Resource></command:parameterValue> <dev:type> <maml:name>List<Resource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Fqdn "sfo-vc01.rainpole.io" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" -Name "MyName" -Sans "sfo-vc01.rainpole.io" $CertificatesGenerationSpec = Initialize-VcfCertificatesGenerationSpec -CaType "One among: OpenSSL, Microsoft" -Resources $Resource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCertificatesGenerationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CertificatesGenerationSpec = Initialize-VcfCertificatesGenerationSpec -CaType "One among: OpenSSL, Microsoft" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCertificatesGenerationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CertificatesGenerationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCheckSetQueryDomainResources</command:name> <command:verb>Initialize</command:verb> <command:noun>CheckSetQueryDomainResources</command:noun> <maml:description> <maml:para>Spec representing a set of resources in a domain to query check-sets for</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec representing a set of resources in a domain to query check-sets for</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCheckSetQueryDomainResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Id of the domain to search for resources in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Resources in the domain to generate check-set candidates for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<CheckSetQueryResource></command:parameterValue> <dev:type> <maml:name>List<CheckSetQueryResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Id of the domain to search for resources in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Resources in the domain to generate check-set candidates for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<CheckSetQueryResource></command:parameterValue> <dev:type> <maml:name>List<CheckSetQueryResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CheckSetQueryResource = Initialize-VcfCheckSetQueryResource -ResourceType "VCENTER" -ResourceId "187f6468-f9e0-45f5-8d34-b28efc1e7a36" -ResourceTargetVersion "3.0.0-123456" $CheckSetQueryDomainResources = Initialize-VcfCheckSetQueryDomainResources -DomainId "MyDomainId" -Resources $CheckSetQueryResource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetQueryDomainResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CheckSetQueryDomainResources = Initialize-VcfCheckSetQueryDomainResources -DomainId "MyDomainId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetQueryDomainResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CheckSetQueryDomainResources</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCheckSetQueryInput</command:name> <command:verb>Initialize</command:verb> <command:noun>CheckSetQueryInput</command:noun> <maml:description> <maml:para>Check-set query input</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Check-set query input</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCheckSetQueryInput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSetType</maml:name> <maml:Description> <maml:para>Type of the check sets to query for. e.g. 'UPGRADE'</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domains</maml:name> <maml:Description> <maml:para>List of domain resources to query check-sets of the given type for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<CheckSetQueryDomainResources></command:parameterValue> <dev:type> <maml:name>List<CheckSetQueryDomainResources></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSetType</maml:name> <maml:Description> <maml:para>Type of the check sets to query for. e.g. 'UPGRADE'</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domains</maml:name> <maml:Description> <maml:para>List of domain resources to query check-sets of the given type for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<CheckSetQueryDomainResources></command:parameterValue> <dev:type> <maml:name>List<CheckSetQueryDomainResources></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CheckSetQueryResource = Initialize-VcfCheckSetQueryResource -ResourceType "VCENTER" -ResourceId "187f6468-f9e0-45f5-8d34-b28efc1e7a36" -ResourceTargetVersion "3.0.0-123456" $CheckSetQueryDomainResources = Initialize-VcfCheckSetQueryDomainResources -DomainId "MyDomainId" -Resources $CheckSetQueryResource $CheckSetQueryInput = Initialize-VcfCheckSetQueryInput -CheckSetType "UPGRADE" -Domains $CheckSetQueryDomainResources </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetQueryInput with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CheckSetQueryDomainResources = Initialize-VcfCheckSetQueryDomainResources -DomainId "MyDomainId" $CheckSetQueryInput = Initialize-VcfCheckSetQueryInput -CheckSetType "UPGRADE" -Domains $CheckSetQueryDomainResources </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetQueryInput with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CheckSetQueryInput</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCheckSetQueryResource</command:name> <command:verb>Initialize</command:verb> <command:noun>CheckSetQueryResource</command:noun> <maml:description> <maml:para>Resource input to query check-sets for</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resource input to query check-sets for</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCheckSetQueryResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Type of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>UUID of the resource, if used adds additional filtering</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceTargetVersion</maml:name> <maml:Description> <maml:para>Upgrade target version for the resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Type of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>UUID of the resource, if used adds additional filtering</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceTargetVersion</maml:name> <maml:Description> <maml:para>Upgrade target version for the resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CheckSetQueryResource = Initialize-VcfCheckSetQueryResource -ResourceType "VCENTER" -ResourceId "187f6468-f9e0-45f5-8d34-b28efc1e7a36" -ResourceTargetVersion "3.0.0-123456" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetQueryResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CheckSetQueryResource = Initialize-VcfCheckSetQueryResource -ResourceType "VCENTER" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetQueryResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CheckSetQueryResource</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCheckSetResourceSelection</command:name> <command:verb>Initialize</command:verb> <command:noun>CheckSetResourceSelection</command:noun> <maml:description> <maml:para>Represents a selection of check-set candidates over a given resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a selection of check-set candidates over a given resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCheckSetResourceSelection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Name of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Id of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Type of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainInfo</command:parameterValue> <dev:type> <maml:name>DomainInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSets</maml:name> <maml:Description> <maml:para>Information about the selected check-set candidates</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SelectedCheckSetCandidate></command:parameterValue> <dev:type> <maml:name>List<SelectedCheckSetCandidate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Name of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Id of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Type of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainInfo</command:parameterValue> <dev:type> <maml:name>DomainInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSets</maml:name> <maml:Description> <maml:para>Information about the selected check-set candidates</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SelectedCheckSetCandidate></command:parameterValue> <dev:type> <maml:name>List<SelectedCheckSetCandidate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DomainInfo = Initialize-VcfDomainInfo -DomainName "MyDomainName" -DomainType "MANAGEMENT" -DomainId "MyDomainId" $SelectedCheckSetCandidate = Initialize-VcfSelectedCheckSetCandidate -CheckSetId "MyCheckSetId" $CheckSetResourceSelection = Initialize-VcfCheckSetResourceSelection -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "MyResourceType" -Domain $DomainInfo -CheckSets $SelectedCheckSetCandidate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetResourceSelection with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SelectedCheckSetCandidate = Initialize-VcfSelectedCheckSetCandidate -CheckSetId "MyCheckSetId" $CheckSetResourceSelection = Initialize-VcfCheckSetResourceSelection -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "MyResourceType" -CheckSets $SelectedCheckSetCandidate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetResourceSelection with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CheckSetResourceSelection</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDomainInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCheckSetRunInput</command:name> <command:verb>Initialize</command:verb> <command:noun>CheckSetRunInput</command:noun> <maml:description> <maml:para>Check-set selection for resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Check-set selection for resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCheckSetRunInput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Id of the query the selection was based on</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Information about the resource and its selection</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<CheckSetResourceSelection></command:parameterValue> <dev:type> <maml:name>List<CheckSetResourceSelection></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Id of the query the selection was based on</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Information about the resource and its selection</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<CheckSetResourceSelection></command:parameterValue> <dev:type> <maml:name>List<CheckSetResourceSelection></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DomainInfo = Initialize-VcfDomainInfo -DomainName "MyDomainName" -DomainType "MANAGEMENT" -DomainId "MyDomainId" $SelectedCheckSetCandidate = Initialize-VcfSelectedCheckSetCandidate -CheckSetId "MyCheckSetId" $CheckSetResourceSelection = Initialize-VcfCheckSetResourceSelection -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "MyResourceType" -Domain $DomainInfo -CheckSets $SelectedCheckSetCandidate $CheckSetRunInput = Initialize-VcfCheckSetRunInput -QueryId "MyQueryId" -Resources $CheckSetResourceSelection </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetRunInput with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SelectedCheckSetCandidate = Initialize-VcfSelectedCheckSetCandidate -CheckSetId "MyCheckSetId" $CheckSetResourceSelection = Initialize-VcfCheckSetResourceSelection -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "MyResourceType" -CheckSets $SelectedCheckSetCandidate $CheckSetRunInput = Initialize-VcfCheckSetRunInput -QueryId "MyQueryId" -Resources $CheckSetResourceSelection </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCheckSetRunInput with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CheckSetRunInput</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetLastAssessmentRunInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetLastAssessmentRunInfo</command:noun> <maml:description> <maml:para>Get information about the last assessment run</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about the last assessment run</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetLastAssessmentRunInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Id of the domain to filter tasks for, accepts multiple values as comma separated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Id of the domain to filter tasks for, accepts multiple values as comma separated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<AssessmentTaskInfo></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetLastAssessmentRunInfo -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLastAssessmentRunInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetLastAssessmentRunInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLastAssessmentRunInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/check-sets/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetResult</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetResult</command:noun> <maml:description> <maml:para>Get the result for a given check run</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the result for a given check run</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetResult</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RunId</maml:name> <maml:Description> <maml:para>UUID of the task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RunId</maml:name> <maml:Description> <maml:para>UUID of the task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AssessmentOutput</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetResult -runId 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResult with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetResult -runId 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResult with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/check-sets/runid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfQueryCheckSets</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfQueryCheckSets</command:noun> <maml:description> <maml:para>Query for check-sets for the given resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Query for check-sets for the given resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfQueryCheckSets</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSetQueryInput</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CheckSetQueryInput</command:parameterValue> <dev:type> <maml:name>CheckSetQueryInput</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSetQueryInput</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CheckSetQueryInput</command:parameterValue> <dev:type> <maml:name>CheckSetQueryInput</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CheckSetQueryResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CheckSetQueryResource = Initialize-VcfCheckSetQueryResource -ResourceType "VCENTER" -ResourceId "187f6468-f9e0-45f5-8d34-b28efc1e7a36" -ResourceTargetVersion "3.0.0-123456" $CheckSetQueryDomainResources = Initialize-VcfCheckSetQueryDomainResources -DomainId "MyDomainId" -Resources $CheckSetQueryResource $CheckSetQueryInput = Initialize-VcfCheckSetQueryInput -CheckSetType "UPGRADE" -Domains $CheckSetQueryDomainResources Invoke-VcfQueryCheckSets -checkSetQueryInput $checkSetQueryInput </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfQueryCheckSets with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CheckSetQueryDomainResources = Initialize-VcfCheckSetQueryDomainResources -DomainId "MyDomainId" $CheckSetQueryInput = Initialize-VcfCheckSetQueryInput -CheckSetType "UPGRADE" -Domains $CheckSetQueryDomainResources Invoke-VcfQueryCheckSets -checkSetQueryInput $checkSetQueryInput </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfQueryCheckSets with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/check-sets/queries/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCheckSetQueryInput</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfTriggerCheckRun</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfTriggerCheckRun</command:noun> <maml:description> <maml:para>Trigger a run of the selected checks</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Trigger a run of the selected checks</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfTriggerCheckRun</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSetRunInput</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CheckSetRunInput</command:parameterValue> <dev:type> <maml:name>CheckSetRunInput</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSetRunInput</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CheckSetRunInput</command:parameterValue> <dev:type> <maml:name>CheckSetRunInput</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DomainInfo = Initialize-VcfDomainInfo -DomainName "MyDomainName" -DomainType "MANAGEMENT" -DomainId "MyDomainId" $SelectedCheckSetCandidate = Initialize-VcfSelectedCheckSetCandidate -CheckSetId "MyCheckSetId" $CheckSetResourceSelection = Initialize-VcfCheckSetResourceSelection -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "MyResourceType" -Domain $DomainInfo -CheckSets $SelectedCheckSetCandidate $CheckSetRunInput = Initialize-VcfCheckSetRunInput -QueryId "MyQueryId" -Resources $CheckSetResourceSelection Invoke-VcfTriggerCheckRun -checkSetRunInput $checkSetRunInput </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfTriggerCheckRun with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SelectedCheckSetCandidate = Initialize-VcfSelectedCheckSetCandidate -CheckSetId "MyCheckSetId" $CheckSetResourceSelection = Initialize-VcfCheckSetResourceSelection -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "MyResourceType" -CheckSets $SelectedCheckSetCandidate $CheckSetRunInput = Initialize-VcfCheckSetRunInput -QueryId "MyQueryId" -Resources $CheckSetResourceSelection Invoke-VcfTriggerCheckRun -checkSetRunInput $checkSetRunInput </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfTriggerCheckRun with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/check-sets/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCheckSetRunInput</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfTriggerPartialRetryOfCheckRun</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfTriggerPartialRetryOfCheckRun</command:noun> <maml:description> <maml:para>Trigger partial retry of a completed check run</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Trigger partial retry of a completed check run</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfTriggerPartialRetryOfCheckRun</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RunId</maml:name> <maml:Description> <maml:para>UUID of the assessment to retry</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AssessmentPartialRetryInput</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AssessmentPartialRetryInput</command:parameterValue> <dev:type> <maml:name>AssessmentPartialRetryInput</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RunId</maml:name> <maml:Description> <maml:para>UUID of the assessment to retry</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AssessmentPartialRetryInput</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AssessmentPartialRetryInput</command:parameterValue> <dev:type> <maml:name>AssessmentPartialRetryInput</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AssessmentPartialRetryInput = Initialize-VcfAssessmentPartialRetryInput -ErrorIds "MyErrorIds" -Options @{ key_example = "{"discoveryCaching":"true"}" } Invoke-VcfTriggerPartialRetryOfCheckRun -runId 38400000-8cf0-11bd-b23e-10b96e4ef00d -assessmentPartialRetryInput $assessmentPartialRetryInput </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfTriggerPartialRetryOfCheckRun with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AssessmentPartialRetryInput = Initialize-VcfAssessmentPartialRetryInput -ErrorIds "MyErrorIds" Invoke-VcfTriggerPartialRetryOfCheckRun -runId 38400000-8cf0-11bd-b23e-10b96e4ef00d -assessmentPartialRetryInput $assessmentPartialRetryInput </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfTriggerPartialRetryOfCheckRun with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/check-sets/runid/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfAssessmentPartialRetryInput</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterCompactionSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterCompactionSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to remove one or more vSphere hosts from existing cluster in a workload domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to remove one or more vSphere hosts from existing cluster in a workload domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterCompactionSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Hosts</maml:name> <maml:Description> <maml:para>List of vSphere hosts to be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostReference></command:parameterValue> <dev:type> <maml:name>List<HostReference></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Force removal of vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceByPassingSafeMinSize</maml:name> <maml:Description> <maml:para>Remove dead hosts from cluster, bypassing validations. Forced removal may result in permanent data loss. Review recovery plan with VMware Support before using.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Hosts</maml:name> <maml:Description> <maml:para>List of vSphere hosts to be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostReference></command:parameterValue> <dev:type> <maml:name>List<HostReference></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Force removal of vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceByPassingSafeMinSize</maml:name> <maml:Description> <maml:para>Remove dead hosts from cluster, bypassing validations. Forced removal may result in permanent data loss. Review recovery plan with VMware Support before using.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VMNicInfo = Initialize-VcfVMNicInfo -Name "MyName" -LinkSpeedMB 0 -IsInUse $false -IsAutoNegotiateSupported $false -IsActive $false $HostReference = Initialize-VcfHostReference -Id "MyId" -IpAddress "MyIpAddress" -Fqdn "MyFqdn" -VmNics $VMNicInfo -AzName "MyAzName" $ClusterCompactionSpec = Initialize-VcfClusterCompactionSpec -Hosts $HostReference -Force $false -ForceByPassingSafeMinSize $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterCompactionSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostReference = Initialize-VcfHostReference $ClusterCompactionSpec = Initialize-VcfClusterCompactionSpec -Hosts $HostReference </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterCompactionSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterCompactionSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterCreationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterCreationSpec</command:noun> <maml:description> <maml:para>Cluster creation specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Cluster creation specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterCreationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>ID of the domain to which the clusters will be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComputeSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ComputeSpec</command:parameterValue> <dev:type> <maml:name>ComputeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeployWithoutLicenseKeys</maml:name> <maml:Description> <maml:para>Flag that indicates if the deployment should happen without license keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>ID of the domain to which the clusters will be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComputeSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ComputeSpec</command:parameterValue> <dev:type> <maml:name>ComputeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeployWithoutLicenseKeys</maml:name> <maml:Description> <maml:para>Flag that indicates if the deployment should happen without license keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec -SkipFailedHosts $false $ClusterCreationSpec = Initialize-VcfClusterCreationSpec -DomainId "MyDomainId" -ComputeSpec $ComputeSpec -DeployWithoutLicenseKeys $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostSpec = Initialize-VcfHostSpec -Id "MyId" $DatastoreSpec = Initialize-VcfDatastoreSpec $NetworkSpec = Initialize-VcfNetworkSpec $ClusterSpec = Initialize-VcfClusterSpec -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec $ClusterCreationSpec = Initialize-VcfClusterCreationSpec -DomainId "MyDomainId" -ComputeSpec $ComputeSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterCreationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfComputeSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterCriterion</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterCriterion</command:noun> <maml:description> <maml:para>Represents a criterion for querying the cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a criterion for querying the cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterCriterion</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ClusterCriterion = Initialize-VcfClusterCriterion -Name "One among: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ClusterCriterion = Initialize-VcfClusterCriterion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterCriterion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterExpansionNetworkProfile</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterExpansionNetworkProfile</command:noun> <maml:description> <maml:para>This specification contains the host switch configurations for the NSX transport node.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the host switch configurations for the NSX transport node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterExpansionNetworkProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The network profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The network profile description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtHostSwitchConfigs</maml:name> <maml:Description> <maml:para>The list of NSX host switch configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtHostSwitchConfig></command:parameterValue> <dev:type> <maml:name>List<NsxtHostSwitchConfig></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The network profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The network profile description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtHostSwitchConfigs</maml:name> <maml:Description> <maml:para>The list of NSX host switch configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtHostSwitchConfig></command:parameterValue> <dev:type> <maml:name>List<NsxtHostSwitchConfig></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $ClusterExpansionNetworkProfile = Initialize-VcfClusterExpansionNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterExpansionNetworkProfile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -VdsUplinkToNsxUplink $UplinkMapping $ClusterExpansionNetworkProfile = Initialize-VcfClusterExpansionNetworkProfile -Name "MyName" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterExpansionNetworkProfile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterExpansionNetworkProfile</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterExpansionNetworkSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterExpansionNetworkSpec</command:noun> <maml:description> <maml:para>This specification contains cluster network configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains cluster network configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterExpansionNetworkSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterExpansionNsxSpec</command:parameterValue> <dev:type> <maml:name>ClusterExpansionNsxSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkProfiles</maml:name> <maml:Description> <maml:para>The list of network profiles</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ClusterExpansionNetworkProfile></command:parameterValue> <dev:type> <maml:name>List<ClusterExpansionNetworkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterExpansionNsxSpec</command:parameterValue> <dev:type> <maml:name>ClusterExpansionNsxSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkProfiles</maml:name> <maml:Description> <maml:para>The list of network profiles</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ClusterExpansionNetworkProfile></command:parameterValue> <dev:type> <maml:name>List<ClusterExpansionNetworkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $ClusterExpansionNsxSpec = Initialize-VcfClusterExpansionNsxSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $ClusterExpansionNetworkProfile = Initialize-VcfClusterExpansionNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterExpansionNetworkSpec = Initialize-VcfClusterExpansionNetworkSpec -NsxClusterSpec $ClusterExpansionNsxSpec -NetworkProfiles $ClusterExpansionNetworkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterExpansionNetworkSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec $ClusterExpansionNsxSpec = Initialize-VcfClusterExpansionNsxSpec -UplinkProfiles $UplinkProfile $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -VdsUplinkToNsxUplink $UplinkMapping $ClusterExpansionNetworkProfile = Initialize-VcfClusterExpansionNetworkProfile -Name "MyName" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterExpansionNetworkSpec = Initialize-VcfClusterExpansionNetworkSpec -NsxClusterSpec $ClusterExpansionNsxSpec -NetworkProfiles $ClusterExpansionNetworkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterExpansionNetworkSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterExpansionNetworkSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterExpansionNsxSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterExpansionNsxSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterExpansionNsxSpec</command:noun> <maml:description> <maml:para>This specification contains NSX configuration for cluster expansion</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains NSX configuration for cluster expansion</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterExpansionNsxSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolsSpec</maml:name> <maml:Description> <maml:para>The IP address pools specification</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkProfiles</maml:name> <maml:Description> <maml:para>The list of uplink profile specifications.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<UplinkProfile></command:parameterValue> <dev:type> <maml:name>List<UplinkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolsSpec</maml:name> <maml:Description> <maml:para>The IP address pools specification</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkProfiles</maml:name> <maml:Description> <maml:para>The list of uplink profile specifications.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<UplinkProfile></command:parameterValue> <dev:type> <maml:name>List<UplinkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $ClusterExpansionNsxSpec = Initialize-VcfClusterExpansionNsxSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterExpansionNsxSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec $ClusterExpansionNsxSpec = Initialize-VcfClusterExpansionNsxSpec -UplinkProfiles $UplinkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterExpansionNsxSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterExpansionNsxSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterExpansionSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterExpansionSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to add one or more vSphere hosts to an existing cluster in a workload domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to add one or more vSphere hosts to an existing cluster in a workload domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterExpansionSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostSpecs</maml:name> <maml:Description> <maml:para>List of vSphere host information from the free pool to consume in the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostSpec></command:parameterValue> <dev:type> <maml:name>List<HostSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterExpansionNetworkSpec</command:parameterValue> <dev:type> <maml:name>ClusterExpansionNetworkSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanNetworkSpecs</maml:name> <maml:Description> <maml:para>vSAN Network Pool Spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VSANNetworkSpec></command:parameterValue> <dev:type> <maml:name>List<VSANNetworkSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WitnessSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WitnessSpec</command:parameterValue> <dev:type> <maml:name>WitnessSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WitnessTrafficSharedWithVsanTraffic</maml:name> <maml:Description> <maml:para>Witness traffic to be shared with vSAN traffic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeployWithoutLicenseKeys</maml:name> <maml:Description> <maml:para>Flag that indicates if the deployment should happen without license keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InterRackExpansion</maml:name> <maml:Description> <maml:para>Is inter-rack cluster(true for L2 non-uniform and L3 : At least one of management, uplink, Edge and host TEP networks is different for hosts of the cluster, false for L2 uniform : All hosts in cluster have identical management, uplink, Edge and host TEP networks) expansion. Required, only if Cluster contains NSX Edge Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceHostAdditionInPresenceofDeadHosts</maml:name> <maml:Description> <maml:para>Use to add host to a cluster with dead host(s). Bypasses validation of disconnected hosts and vSAN cluster health. Review recovery plan VMware Support before using. False if omitted. This property is deprecated and it has no effect when using it.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipThumbprintValidation</maml:name> <maml:Description> <maml:para>Skip thumbprint validation for ESXi hosts during add host operation. This property is deprecated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostSpecs</maml:name> <maml:Description> <maml:para>List of vSphere host information from the free pool to consume in the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostSpec></command:parameterValue> <dev:type> <maml:name>List<HostSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterExpansionNetworkSpec</command:parameterValue> <dev:type> <maml:name>ClusterExpansionNetworkSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanNetworkSpecs</maml:name> <maml:Description> <maml:para>vSAN Network Pool Spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VSANNetworkSpec></command:parameterValue> <dev:type> <maml:name>List<VSANNetworkSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WitnessSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WitnessSpec</command:parameterValue> <dev:type> <maml:name>WitnessSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WitnessTrafficSharedWithVsanTraffic</maml:name> <maml:Description> <maml:para>Witness traffic to be shared with vSAN traffic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeployWithoutLicenseKeys</maml:name> <maml:Description> <maml:para>Flag that indicates if the deployment should happen without license keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InterRackExpansion</maml:name> <maml:Description> <maml:para>Is inter-rack cluster(true for L2 non-uniform and L3 : At least one of management, uplink, Edge and host TEP networks is different for hosts of the cluster, false for L2 uniform : All hosts in cluster have identical management, uplink, Edge and host TEP networks) expansion. Required, only if Cluster contains NSX Edge Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceHostAdditionInPresenceofDeadHosts</maml:name> <maml:Description> <maml:para>Use to add host to a cluster with dead host(s). Bypasses validation of disconnected hosts and vSAN cluster health. Review recovery plan VMware Support before using. False if omitted. This property is deprecated and it has no effect when using it.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipThumbprintValidation</maml:name> <maml:Description> <maml:para>Skip thumbprint validation for ESXi hosts during add host operation. This property is deprecated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $ClusterExpansionNsxSpec = Initialize-VcfClusterExpansionNsxSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $ClusterExpansionNetworkProfile = Initialize-VcfClusterExpansionNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterExpansionNetworkSpec = Initialize-VcfClusterExpansionNetworkSpec -NsxClusterSpec $ClusterExpansionNsxSpec -NetworkProfiles $ClusterExpansionNetworkProfile $VSANNetworkSpec = Initialize-VcfVSANNetworkSpec -VsanGatewayIP "MyVsanGatewayIP" -VsanCidr "MyVsanCidr" $WitnessSpec = Initialize-VcfWitnessSpec -VsanIp "MyVsanIp" -Fqdn "MyFqdn" -VsanCidr "MyVsanCidr" $ClusterExpansionSpec = Initialize-VcfClusterExpansionSpec -HostSpecs $HostSpec -NetworkSpec $ClusterExpansionNetworkSpec -VsanNetworkSpecs $VSANNetworkSpec -WitnessSpec $WitnessSpec -WitnessTrafficSharedWithVsanTraffic $false -DeployWithoutLicenseKeys $false -InterRackExpansion $false -ForceHostAdditionInPresenceofDeadHosts $false -SkipThumbprintValidation $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterExpansionSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostSpec = Initialize-VcfHostSpec -Id "MyId" $ClusterExpansionSpec = Initialize-VcfClusterExpansionSpec -HostSpecs $HostSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterExpansionSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterExpansionSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterExpansionNetworkSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfWitnessSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterNetworkConfigurationCriterion</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterNetworkConfigurationCriterion</command:noun> <maml:description> <maml:para>Represents criterion for querying the network properties of a cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents criterion for querying the network properties of a cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterNetworkConfigurationCriterion</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ClusterNetworkConfigurationCriterion = Initialize-VcfClusterNetworkConfigurationCriterion -Name "One among: VCENTER_NSXT_NETWORK_CONFIG, VCENTER_NETWORK_CONFIG_SUMMARY, NSX_NETWORK_CONFIG_PREVIEW_POST_DRIFT" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterNetworkConfigurationCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ClusterNetworkConfigurationCriterion = Initialize-VcfClusterNetworkConfigurationCriterion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterNetworkConfigurationCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterNetworkConfigurationCriterion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddDatastoreToCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddDatastoreToCluster</command:noun> <maml:description> <maml:para>Mount a datastore to a cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddDatastoreToCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreMountSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreMountSpec</command:parameterValue> <dev:type> <maml:name>DatastoreMountSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreMountSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreMountSpec</command:parameterValue> <dev:type> <maml:name>DatastoreMountSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $DatastoreMountSpec = Initialize-VcfDatastoreMountSpec -DatastoreSpec $DatastoreSpec Invoke-VcfAddDatastoreToCluster -id "Myid" -datastoreMountSpec $datastoreMountSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddDatastoreToCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastoreSpec = Initialize-VcfDatastoreSpec $DatastoreMountSpec = Initialize-VcfDatastoreMountSpec -DatastoreSpec $DatastoreSpec Invoke-VcfAddDatastoreToCluster -id "Myid" -datastoreMountSpec $datastoreMountSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddDatastoreToCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/datastores/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDatastoreMountSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAssignTagsToCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAssignTagsToCluster</command:noun> <maml:description> <maml:para>Assign Tags to Cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAssignTagsToCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagAssignmentResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfAssignTagsToCluster -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAssignTagsToCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfAssignTagsToCluster -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAssignTagsToCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/tags/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfTagsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCreateCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCreateCluster</command:noun> <maml:description> <maml:para>Create a cluster and add to an existing domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCreateCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCreationSpec</command:parameterValue> <dev:type> <maml:name>ClusterCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCreationSpec</command:parameterValue> <dev:type> <maml:name>ClusterCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec -SkipFailedHosts $false $ClusterCreationSpec = Initialize-VcfClusterCreationSpec -DomainId "MyDomainId" -ComputeSpec $ComputeSpec -DeployWithoutLicenseKeys $false Invoke-VcfCreateCluster -clusterCreationSpec $clusterCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostSpec = Initialize-VcfHostSpec -Id "MyId" $DatastoreSpec = Initialize-VcfDatastoreSpec $NetworkSpec = Initialize-VcfNetworkSpec $ClusterSpec = Initialize-VcfClusterSpec -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec $ClusterCreationSpec = Initialize-VcfClusterCreationSpec -DomainId "MyDomainId" -ComputeSpec $ComputeSpec Invoke-VcfCreateCluster -clusterCreationSpec $clusterCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteCluster</command:noun> <maml:description> <maml:para>Delete a cluster from a domain if it has been previously initialized for deletion</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Force deletion of the cluster. Please note when passed true, deletion will ignore vCenter Server connection issues and could possible leave cluster related resources in the vCenter Server if a connection cannot be established.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Force deletion of the cluster. Please note when passed true, deletion will ignore vCenter Server connection issues and could possible leave cluster related resources in the vCenter Server if a connection cannot be established.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteCluster -id "Myid" -force $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCluster</command:noun> <maml:description> <maml:para>Get a cluster by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Cluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterCreateValidation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterCreateValidation</command:noun> <maml:description> <maml:para>Get the status of the validations for cluster deployment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the status of given cluster create validation workflow by given validation id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterCreateValidation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster validation workflow id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster validation workflow id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterCreateValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterCreateValidation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterCreateValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterCreateValidation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/validations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterDatastores</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterDatastores</command:noun> <maml:description> <maml:para>Get the list of all datastores associated with the cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterDatastores</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Datastore></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterDatastores -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterDatastores with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterDatastores -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterDatastores with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/datastores/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterNetworkConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterNetworkConfiguration</command:noun> <maml:description> <maml:para>Get cluster network configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterNetworkConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterNetworkConfigurationCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterNetworkConfigurationCriterion</command:parameterValue> <dev:type> <maml:name>ClusterNetworkConfigurationCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterNetworkConfigurationCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterNetworkConfigurationCriterion</command:parameterValue> <dev:type> <maml:name>ClusterNetworkConfigurationCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ClusterNetworkConfigurationQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ClusterNetworkConfigurationCriterion = Initialize-VcfClusterNetworkConfigurationCriterion -Name "One among: VCENTER_NSXT_NETWORK_CONFIG, VCENTER_NETWORK_CONFIG_SUMMARY, NSX_NETWORK_CONFIG_PREVIEW_POST_DRIFT" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" Invoke-VcfGetClusterNetworkConfiguration -id "Myid" -clusterNetworkConfigurationCriterion $clusterNetworkConfigurationCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterNetworkConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ClusterNetworkConfigurationCriterion = Initialize-VcfClusterNetworkConfigurationCriterion Invoke-VcfGetClusterNetworkConfiguration -id "Myid" -clusterNetworkConfigurationCriterion $clusterNetworkConfigurationCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterNetworkConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/network/queries/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterNetworkConfigurationCriterion</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterNetworkConfigurationCriteria</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterNetworkConfigurationCriteria</command:noun> <maml:description> <maml:para>Get cluster network configuration criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterNetworkConfigurationCriteria</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterNetworkConfigurationCriteria -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterNetworkConfigurationCriteria with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterNetworkConfigurationCriteria -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterNetworkConfigurationCriteria with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/network/criteria/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterNetworkConfigurationQueryResponse</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterNetworkConfigurationQueryResponse</command:noun> <maml:description> <maml:para>Get cluster network configuration query response</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The response retrieved is only applicable for pure L2 domain clusters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterNetworkConfigurationQueryResponse</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ClusterNetworkConfigurationQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterNetworkConfigurationQueryResponse -id "Myid" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterNetworkConfigurationQueryResponse with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterNetworkConfigurationQueryResponse -id "Myid" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterNetworkConfigurationQueryResponse with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/network/queries/queryid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterTagManagerUrl</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterTagManagerUrl</command:noun> <maml:description> <maml:para>Get Cluster Tag Manager Url</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterTagManagerUrl</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagManagerModel</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterTagManagerUrl -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterTagManagerUrl with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterTagManagerUrl -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterTagManagerUrl with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/tags/tag-manager/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterUpdateValidation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterUpdateValidation</command:noun> <maml:description> <maml:para>Get the status of the validations for cluster updates</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the status of given cluster updates validation workflow by given validation id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterUpdateValidation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ValidationId</maml:name> <maml:Description> <maml:para>Cluster validation workflow id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UseAsyncValidation</maml:name> <maml:Description> <maml:para>Cluster validation result for async validations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ValidationId</maml:name> <maml:Description> <maml:para>Cluster validation workflow id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UseAsyncValidation</maml:name> <maml:Description> <maml:para>Cluster validation result for async validations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterUpdateValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d -validationId 38400000-8cf0-11bd-b23e-10b96e4ef00d -useAsyncValidation $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterUpdateValidation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterUpdateValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d -validationId 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterUpdateValidation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/validations/validationid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusters</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusters</command:noun> <maml:description> <maml:para>Retrieve a list of clusters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusters</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsStretched</maml:name> <maml:Description> <maml:para>Is cluster vSAN stretched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsImageBased</maml:name> <maml:Description> <maml:para>Is cluster managed using vSphere lifecycle Manager Images</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>ID of the Domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsStretched</maml:name> <maml:Description> <maml:para>Is cluster vSAN stretched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsImageBased</maml:name> <maml:Description> <maml:para>Is cluster managed using vSphere lifecycle Manager Images</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>ID of the Domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusters -isStretched $true -isImageBased $true -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDatastoreCriterion1</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDatastoreCriterion1</command:noun> <maml:description> <maml:para>Get a criterion to query for datastore</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDatastoreCriterion1</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Criteria Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Criteria Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DatastoreCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoreCriterion1 -id "Myid" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoreCriterion1 with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoreCriterion1 -id "Myid" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoreCriterion1 with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/datastores/criteria/name/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDatastoreQueryResponse1</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDatastoreQueryResponse1</command:noun> <maml:description> <maml:para>Get Datastore query response</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDatastoreQueryResponse1</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DatastoreQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoreQueryResponse1 -clusterId "MyclusterId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoreQueryResponse1 with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoreQueryResponse1 -clusterId "MyclusterId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoreQueryResponse1 with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/clusterid/datastores/queries/queryid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDatastoresCriteria1</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDatastoresCriteria1</command:noun> <maml:description> <maml:para>Get all datastore criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDatastoresCriteria1</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfDatastoreCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoresCriteria1 -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoresCriteria1 with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoresCriteria1 -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoresCriteria1 with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/datastores/criteria/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHostCriteria</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHostCriteria</command:noun> <maml:description> <maml:para>Get all host criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHostCriteria</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfHostCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostCriteria -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostCriteria with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostCriteria -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostCriteria with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/hosts/criteria/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHostCriterion</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHostCriterion</command:noun> <maml:description> <maml:para>Get a criterion to query for host</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHostCriterion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Criteria Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Criteria Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HostCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostCriterion -id "Myid" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostCriterion -id "Myid" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/hosts/criteria/name/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHostQueryResponse1</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHostQueryResponse1</command:noun> <maml:description> <maml:para>Get query response</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHostQueryResponse1</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HostQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostQueryResponse1 -clusterId "MyclusterId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostQueryResponse1 with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostQueryResponse1 -clusterId "MyclusterId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostQueryResponse1 with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/clusterid/hosts/queries/queryid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTagAssignableForCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTagAssignableForCluster</command:noun> <maml:description> <maml:para>Get tags assignable to a cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTagAssignableForCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTag</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagAssignableForCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagAssignableForCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagAssignableForCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagAssignableForCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/tags/assignable-tags/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTagsAssignedToCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTagsAssignedToCluster</command:noun> <maml:description> <maml:para>Get tags assigned to a cluster by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTagsAssignedToCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTag</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/tags/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTagsAssignedToClusters</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTagsAssignedToClusters</command:noun> <maml:description> <maml:para>Get tags assigned to clusters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTagsAssignedToClusters</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTagsForResource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToClusters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToClusters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToClusters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToClusters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/tags/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVdses</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVdses</command:noun> <maml:description> <maml:para>Get the list of VDSes of a cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVdses</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Vds></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVdses -clusterId "MyclusterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVdses with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVdses -clusterId "MyclusterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVdses with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/clusterid/vdses/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfImportVdsToInventory</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfImportVdsToInventory</command:noun> <maml:description> <maml:para>Import Vds to inventory for the given cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfImportVdsToInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ImportVdsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ImportVdsSpec</command:parameterValue> <dev:type> <maml:name>ImportVdsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ImportVdsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ImportVdsSpec</command:parameterValue> <dev:type> <maml:name>ImportVdsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VdsDetail = Initialize-VcfVdsDetail -VdsName "MyVdsName" $ImportVdsSpec = Initialize-VcfImportVdsSpec -ListOfVdsDetails $VdsDetail Invoke-VcfImportVdsToInventory -clusterId "MyclusterId" -importVdsSpec $importVdsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfImportVdsToInventory with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VdsDetail = Initialize-VcfVdsDetail -VdsName "MyVdsName" $ImportVdsSpec = Initialize-VcfImportVdsSpec -ListOfVdsDetails $VdsDetail Invoke-VcfImportVdsToInventory -clusterId "MyclusterId" -importVdsSpec $importVdsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfImportVdsToInventory with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/clusterid/vdses/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfImportVdsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfPostDatastoreQuery1</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfPostDatastoreQuery1</command:noun> <maml:description> <maml:para>Post a datastore query</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfPostDatastoreQuery1</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreCriterion</command:parameterValue> <dev:type> <maml:name>DatastoreCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreCriterion</command:parameterValue> <dev:type> <maml:name>DatastoreCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DatastoreQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DatastoreCriterion = Initialize-VcfDatastoreCriterion -Name "One among: VSAN_REMOTE_DATASTORES" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" Invoke-VcfPostDatastoreQuery1 -id "Myid" -datastoreCriterion $datastoreCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostDatastoreQuery1 with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastoreCriterion = Initialize-VcfDatastoreCriterion Invoke-VcfPostDatastoreQuery1 -id "Myid" -datastoreCriterion $datastoreCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostDatastoreQuery1 with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/datastores/queries/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDatastoreCriterion</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfPostHostQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfPostHostQuery</command:noun> <maml:description> <maml:para>Post a host query</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfPostHostQuery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HostCriterion</command:parameterValue> <dev:type> <maml:name>HostCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HostCriterion</command:parameterValue> <dev:type> <maml:name>HostCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HostQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HostCriterion = Initialize-VcfHostCriterion -Name "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR, UNMANAGED_HOSTS_IN_HCIMGR_MANUAL_DISCOVERY" -SubCriteria $HostCriterion -Arguments @{ key_example = "MyInner" } -Description "MyDescription" Invoke-VcfPostHostQuery -id "Myid" -hostCriterion $hostCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostHostQuery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostCriterion = Initialize-VcfHostCriterion Invoke-VcfPostHostQuery -id "Myid" -hostCriterion $hostCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostHostQuery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/hosts/queries/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHostCriterion</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRemoveDatastoreFromCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRemoveDatastoreFromCluster</command:noun> <maml:description> <maml:para>Unmount a datastore from a cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRemoveDatastoreFromCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreId</maml:name> <maml:Description> <maml:para>Datastore ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreId</maml:name> <maml:Description> <maml:para>Datastore ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveDatastoreFromCluster -id "Myid" -datastoreId "MydatastoreId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveDatastoreFromCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveDatastoreFromCluster -id "Myid" -datastoreId "MydatastoreId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveDatastoreFromCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/datastores/datastoreid/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRemoveTagsFromCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRemoveTagsFromCluster</command:noun> <maml:description> <maml:para>Remove tags from a cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRemoveTagsFromCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagAssignmentResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfRemoveTagsFromCluster -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveTagsFromCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfRemoveTagsFromCluster -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveTagsFromCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/tags/delete/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfTagsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateCluster</command:noun> <maml:description> <maml:para>Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterUpdateSpec</command:parameterValue> <dev:type> <maml:name>ClusterUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterUpdateSpec</command:parameterValue> <dev:type> <maml:name>ClusterUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $ClusterExpansionNsxSpec = Initialize-VcfClusterExpansionNsxSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $ClusterExpansionNetworkProfile = Initialize-VcfClusterExpansionNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterExpansionNetworkSpec = Initialize-VcfClusterExpansionNetworkSpec -NsxClusterSpec $ClusterExpansionNsxSpec -NetworkProfiles $ClusterExpansionNetworkProfile $VSANNetworkSpec = Initialize-VcfVSANNetworkSpec -VsanGatewayIP "MyVsanGatewayIP" -VsanCidr "MyVsanCidr" $WitnessSpec = Initialize-VcfWitnessSpec -VsanIp "MyVsanIp" -Fqdn "MyFqdn" -VsanCidr "MyVsanCidr" $ClusterExpansionSpec = Initialize-VcfClusterExpansionSpec -HostSpecs $HostSpec -NetworkSpec $ClusterExpansionNetworkSpec -VsanNetworkSpecs $VSANNetworkSpec -WitnessSpec $WitnessSpec -WitnessTrafficSharedWithVsanTraffic $false -DeployWithoutLicenseKeys $false -InterRackExpansion $false -ForceHostAdditionInPresenceofDeadHosts $false -SkipThumbprintValidation $false $VMNicInfo = Initialize-VcfVMNicInfo -Name "MyName" -LinkSpeedMB 0 -IsInUse $false -IsAutoNegotiateSupported $false -IsActive $false $HostReference = Initialize-VcfHostReference -Id "MyId" -IpAddress "MyIpAddress" -Fqdn "MyFqdn" -VmNics $VMNicInfo -AzName "MyAzName" $ClusterCompactionSpec = Initialize-VcfClusterCompactionSpec -Hosts $HostReference -Force $false -ForceByPassingSafeMinSize $false $NsxStretchClusterSpec = Initialize-VcfNsxStretchClusterSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $StretchClusterNetworkProfile = Initialize-VcfStretchClusterNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterStretchNetworkSpec = Initialize-VcfClusterStretchNetworkSpec -NsxClusterSpec $NsxStretchClusterSpec -NetworkProfiles $StretchClusterNetworkProfile $ClusterStretchSpec = Initialize-VcfClusterStretchSpec -HostSpecs $HostSpec -WitnessSpec $WitnessSpec -WitnessTrafficSharedWithVsanTraffic $false -VsanNetworkSpecs $VSANNetworkSpec -SecondaryAzOverlayVlanId 0 -NetworkSpec $ClusterStretchNetworkSpec -IsEdgeClusterConfiguredForMultiAZ $false -DeployWithoutLicenseKeys $false $ClusterUpdateSpec = Initialize-VcfClusterUpdateSpec -Name "MyName" -ClusterExpansionSpec $ClusterExpansionSpec -ClusterCompactionSpec $ClusterCompactionSpec -ClusterStretchSpec $ClusterStretchSpec -ClusterUnstretchSpec 0 -MarkForDeletion $false -PrepareForStretch $false Invoke-VcfUpdateCluster -id "Myid" -clusterUpdateSpec $clusterUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ClusterUpdateSpec = Initialize-VcfClusterUpdateSpec Invoke-VcfUpdateCluster -id "Myid" -clusterUpdateSpec $clusterUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateClusterCreationSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateClusterCreationSpec</command:noun> <maml:description> <maml:para>Perform validation of the ClusterCreationSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateClusterCreationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCreationSpec</command:parameterValue> <dev:type> <maml:name>ClusterCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostsOnly</maml:name> <maml:Description> <maml:para>Validate hosts only</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipHostSwitchValidation</maml:name> <maml:Description> <maml:para>Skips host switch validation when hostOnly=true</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCreationSpec</command:parameterValue> <dev:type> <maml:name>ClusterCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostsOnly</maml:name> <maml:Description> <maml:para>Validate hosts only</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipHostSwitchValidation</maml:name> <maml:Description> <maml:para>Skips host switch validation when hostOnly=true</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec -SkipFailedHosts $false $ClusterCreationSpec = Initialize-VcfClusterCreationSpec -DomainId "MyDomainId" -ComputeSpec $ComputeSpec -DeployWithoutLicenseKeys $false Invoke-VcfValidateClusterCreationSpec -clusterCreationSpec $clusterCreationSpec -hostsOnly $true -skipHostSwitchValidation $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateClusterCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostSpec = Initialize-VcfHostSpec -Id "MyId" $DatastoreSpec = Initialize-VcfDatastoreSpec $NetworkSpec = Initialize-VcfNetworkSpec $ClusterSpec = Initialize-VcfClusterSpec -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec $ClusterCreationSpec = Initialize-VcfClusterCreationSpec -DomainId "MyDomainId" -ComputeSpec $ComputeSpec Invoke-VcfValidateClusterCreationSpec -clusterCreationSpec $clusterCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateClusterCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateClusterUpdateSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateClusterUpdateSpec</command:noun> <maml:description> <maml:para>Perform validation of the ClusterUpdateSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateClusterUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterUpdateSpec</command:parameterValue> <dev:type> <maml:name>ClusterUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UseAsyncValidation</maml:name> <maml:Description> <maml:para>Cluster validations to be run async</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterUpdateSpec</command:parameterValue> <dev:type> <maml:name>ClusterUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UseAsyncValidation</maml:name> <maml:Description> <maml:para>Cluster validations to be run async</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $ClusterExpansionNsxSpec = Initialize-VcfClusterExpansionNsxSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $ClusterExpansionNetworkProfile = Initialize-VcfClusterExpansionNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterExpansionNetworkSpec = Initialize-VcfClusterExpansionNetworkSpec -NsxClusterSpec $ClusterExpansionNsxSpec -NetworkProfiles $ClusterExpansionNetworkProfile $VSANNetworkSpec = Initialize-VcfVSANNetworkSpec -VsanGatewayIP "MyVsanGatewayIP" -VsanCidr "MyVsanCidr" $WitnessSpec = Initialize-VcfWitnessSpec -VsanIp "MyVsanIp" -Fqdn "MyFqdn" -VsanCidr "MyVsanCidr" $ClusterExpansionSpec = Initialize-VcfClusterExpansionSpec -HostSpecs $HostSpec -NetworkSpec $ClusterExpansionNetworkSpec -VsanNetworkSpecs $VSANNetworkSpec -WitnessSpec $WitnessSpec -WitnessTrafficSharedWithVsanTraffic $false -DeployWithoutLicenseKeys $false -InterRackExpansion $false -ForceHostAdditionInPresenceofDeadHosts $false -SkipThumbprintValidation $false $VMNicInfo = Initialize-VcfVMNicInfo -Name "MyName" -LinkSpeedMB 0 -IsInUse $false -IsAutoNegotiateSupported $false -IsActive $false $HostReference = Initialize-VcfHostReference -Id "MyId" -IpAddress "MyIpAddress" -Fqdn "MyFqdn" -VmNics $VMNicInfo -AzName "MyAzName" $ClusterCompactionSpec = Initialize-VcfClusterCompactionSpec -Hosts $HostReference -Force $false -ForceByPassingSafeMinSize $false $NsxStretchClusterSpec = Initialize-VcfNsxStretchClusterSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $StretchClusterNetworkProfile = Initialize-VcfStretchClusterNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterStretchNetworkSpec = Initialize-VcfClusterStretchNetworkSpec -NsxClusterSpec $NsxStretchClusterSpec -NetworkProfiles $StretchClusterNetworkProfile $ClusterStretchSpec = Initialize-VcfClusterStretchSpec -HostSpecs $HostSpec -WitnessSpec $WitnessSpec -WitnessTrafficSharedWithVsanTraffic $false -VsanNetworkSpecs $VSANNetworkSpec -SecondaryAzOverlayVlanId 0 -NetworkSpec $ClusterStretchNetworkSpec -IsEdgeClusterConfiguredForMultiAZ $false -DeployWithoutLicenseKeys $false $ClusterUpdateSpec = Initialize-VcfClusterUpdateSpec -Name "MyName" -ClusterExpansionSpec $ClusterExpansionSpec -ClusterCompactionSpec $ClusterCompactionSpec -ClusterStretchSpec $ClusterStretchSpec -ClusterUnstretchSpec 0 -MarkForDeletion $false -PrepareForStretch $false Invoke-VcfValidateClusterUpdateSpec -id "Myid" -clusterUpdateSpec $clusterUpdateSpec -useAsyncValidation $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateClusterUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ClusterUpdateSpec = Initialize-VcfClusterUpdateSpec Invoke-VcfValidateClusterUpdateSpec -id "Myid" -clusterUpdateSpec $clusterUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateClusterUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/id/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateVsanRemoteDatastoreMountSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateVsanRemoteDatastoreMountSpec</command:noun> <maml:description> <maml:para>Perform validation of the DatastoreMountSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateVsanRemoteDatastoreMountSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreMountSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreMountSpec</command:parameterValue> <dev:type> <maml:name>DatastoreMountSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreMountSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreMountSpec</command:parameterValue> <dev:type> <maml:name>DatastoreMountSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $DatastoreMountSpec = Initialize-VcfDatastoreMountSpec -DatastoreSpec $DatastoreSpec Invoke-VcfValidateVsanRemoteDatastoreMountSpec -clusterId "MyclusterId" -datastoreMountSpec $datastoreMountSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateVsanRemoteDatastoreMountSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastoreSpec = Initialize-VcfDatastoreSpec $DatastoreMountSpec = Initialize-VcfDatastoreMountSpec -DatastoreSpec $DatastoreSpec Invoke-VcfValidateVsanRemoteDatastoreMountSpec -clusterId "MyclusterId" -datastoreMountSpec $datastoreMountSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateVsanRemoteDatastoreMountSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/clusterid/datastores/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDatastoreMountSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateVsanRemoteDatastoreSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateVsanRemoteDatastoreSpec</command:noun> <maml:description> <maml:para>Perform validation of the DatastoreMountSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateVsanRemoteDatastoreSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreMountSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreMountSpec</command:parameterValue> <dev:type> <maml:name>DatastoreMountSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreMountSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreMountSpec</command:parameterValue> <dev:type> <maml:name>DatastoreMountSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $DatastoreMountSpec = Initialize-VcfDatastoreMountSpec -DatastoreSpec $DatastoreSpec Invoke-VcfValidateVsanRemoteDatastoreSpec -clusterId "MyclusterId" -datastoreMountSpec $datastoreMountSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateVsanRemoteDatastoreSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastoreSpec = Initialize-VcfDatastoreSpec $DatastoreMountSpec = Initialize-VcfDatastoreMountSpec -DatastoreSpec $DatastoreSpec Invoke-VcfValidateVsanRemoteDatastoreSpec -clusterId "MyclusterId" -datastoreMountSpec $datastoreMountSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateVsanRemoteDatastoreSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/clusters/clusterid/datastores/validation/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDatastoreMountSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to add a cluster to a workload domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to add a cluster to a workload domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the new cluster that will be added to the specified workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterImageId</maml:name> <maml:Description> <maml:para>ID of the Cluster Image to be used with the Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxRailDetails</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VxRailDetails</command:parameterValue> <dev:type> <maml:name>VxRailDetails</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostSpecs</maml:name> <maml:Description> <maml:para>List of vSphere host information from the free pool to consume in the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostSpec></command:parameterValue> <dev:type> <maml:name>List<HostSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreSpec</command:parameterValue> <dev:type> <maml:name>DatastoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkSpec</command:parameterValue> <dev:type> <maml:name>NetworkSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdvancedOptions</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AdvancedOptions</command:parameterValue> <dev:type> <maml:name>AdvancedOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipThumbprintValidation</maml:name> <maml:Description> <maml:para>Skip thumbprint validation for ESXi and VxRail Manager during add cluster/host operation. This property is deprecated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the new cluster that will be added to the specified workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterImageId</maml:name> <maml:Description> <maml:para>ID of the Cluster Image to be used with the Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxRailDetails</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VxRailDetails</command:parameterValue> <dev:type> <maml:name>VxRailDetails</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostSpecs</maml:name> <maml:Description> <maml:para>List of vSphere host information from the free pool to consume in the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostSpec></command:parameterValue> <dev:type> <maml:name>List<HostSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreSpec</command:parameterValue> <dev:type> <maml:name>DatastoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkSpec</command:parameterValue> <dev:type> <maml:name>NetworkSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdvancedOptions</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AdvancedOptions</command:parameterValue> <dev:type> <maml:name>AdvancedOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipThumbprintValidation</maml:name> <maml:Description> <maml:para>Skip thumbprint validation for ESXi and VxRail Manager during add cluster/host operation. This property is deprecated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostSpec = Initialize-VcfHostSpec -Id "MyId" $DatastoreSpec = Initialize-VcfDatastoreSpec $NetworkSpec = Initialize-VcfNetworkSpec $ClusterSpec = Initialize-VcfClusterSpec -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVxRailDetails</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDatastoreSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNetworkSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfAdvancedOptions</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterStretchNetworkSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterStretchNetworkSpec</command:noun> <maml:description> <maml:para>This specification contains network configuration for stretiching a vSan Cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains network configuration for stretiching a vSan Cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterStretchNetworkSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxStretchClusterSpec</command:parameterValue> <dev:type> <maml:name>NsxStretchClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkProfiles</maml:name> <maml:Description> <maml:para>The network profile to be associated with Secondary AZ Hosts in NSX.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<StretchClusterNetworkProfile></command:parameterValue> <dev:type> <maml:name>List<StretchClusterNetworkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxStretchClusterSpec</command:parameterValue> <dev:type> <maml:name>NsxStretchClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkProfiles</maml:name> <maml:Description> <maml:para>The network profile to be associated with Secondary AZ Hosts in NSX.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<StretchClusterNetworkProfile></command:parameterValue> <dev:type> <maml:name>List<StretchClusterNetworkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxStretchClusterSpec = Initialize-VcfNsxStretchClusterSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $StretchClusterNetworkProfile = Initialize-VcfStretchClusterNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterStretchNetworkSpec = Initialize-VcfClusterStretchNetworkSpec -NsxClusterSpec $NsxStretchClusterSpec -NetworkProfiles $StretchClusterNetworkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterStretchNetworkSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec $NsxStretchClusterSpec = Initialize-VcfNsxStretchClusterSpec -UplinkProfiles $UplinkProfile $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -VdsUplinkToNsxUplink $UplinkMapping $StretchClusterNetworkProfile = Initialize-VcfStretchClusterNetworkProfile -Name "MyName" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterStretchNetworkSpec = Initialize-VcfClusterStretchNetworkSpec -NsxClusterSpec $NsxStretchClusterSpec -NetworkProfiles $StretchClusterNetworkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterStretchNetworkSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterStretchNetworkSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxStretchClusterSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterStretchSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterStretchSpec</command:noun> <maml:description> <maml:para>This spec contains the parameters required to convert a Standard vSAN cluster to a Stretched cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This spec contains the parameters required to convert a Standard vSAN cluster to a Stretched cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterStretchSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostSpecs</maml:name> <maml:Description> <maml:para>List of vSphere host information from the free pool to consume in the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostSpec></command:parameterValue> <dev:type> <maml:name>List<HostSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WitnessSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WitnessSpec</command:parameterValue> <dev:type> <maml:name>WitnessSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WitnessTrafficSharedWithVsanTraffic</maml:name> <maml:Description> <maml:para>Witness traffic to be shared with vSAN traffic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanNetworkSpecs</maml:name> <maml:Description> <maml:para>vSAN Network Pool Specs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VSANNetworkSpec></command:parameterValue> <dev:type> <maml:name>List<VSANNetworkSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SecondaryAzOverlayVlanId</maml:name> <maml:Description> <maml:para>Secondary AZ Overlay Vlan Id. This field is deprecated. The secondary AZ overlay vlan id should be mentioned in the uplinkProfile field instead</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterStretchNetworkSpec</command:parameterValue> <dev:type> <maml:name>ClusterStretchNetworkSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsEdgeClusterConfiguredForMultiAZ</maml:name> <maml:Description> <maml:para>Edge cluster configured for multi AZ</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeployWithoutLicenseKeys</maml:name> <maml:Description> <maml:para>Flag that indicates if the deployment should happen without license keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostSpecs</maml:name> <maml:Description> <maml:para>List of vSphere host information from the free pool to consume in the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostSpec></command:parameterValue> <dev:type> <maml:name>List<HostSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WitnessSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WitnessSpec</command:parameterValue> <dev:type> <maml:name>WitnessSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WitnessTrafficSharedWithVsanTraffic</maml:name> <maml:Description> <maml:para>Witness traffic to be shared with vSAN traffic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanNetworkSpecs</maml:name> <maml:Description> <maml:para>vSAN Network Pool Specs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VSANNetworkSpec></command:parameterValue> <dev:type> <maml:name>List<VSANNetworkSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SecondaryAzOverlayVlanId</maml:name> <maml:Description> <maml:para>Secondary AZ Overlay Vlan Id. This field is deprecated. The secondary AZ overlay vlan id should be mentioned in the uplinkProfile field instead</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterStretchNetworkSpec</command:parameterValue> <dev:type> <maml:name>ClusterStretchNetworkSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsEdgeClusterConfiguredForMultiAZ</maml:name> <maml:Description> <maml:para>Edge cluster configured for multi AZ</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeployWithoutLicenseKeys</maml:name> <maml:Description> <maml:para>Flag that indicates if the deployment should happen without license keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $WitnessSpec = Initialize-VcfWitnessSpec -VsanIp "MyVsanIp" -Fqdn "MyFqdn" -VsanCidr "MyVsanCidr" $VSANNetworkSpec = Initialize-VcfVSANNetworkSpec -VsanGatewayIP "MyVsanGatewayIP" -VsanCidr "MyVsanCidr" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxStretchClusterSpec = Initialize-VcfNsxStretchClusterSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $StretchClusterNetworkProfile = Initialize-VcfStretchClusterNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterStretchNetworkSpec = Initialize-VcfClusterStretchNetworkSpec -NsxClusterSpec $NsxStretchClusterSpec -NetworkProfiles $StretchClusterNetworkProfile $ClusterStretchSpec = Initialize-VcfClusterStretchSpec -HostSpecs $HostSpec -WitnessSpec $WitnessSpec -WitnessTrafficSharedWithVsanTraffic $false -VsanNetworkSpecs $VSANNetworkSpec -SecondaryAzOverlayVlanId 0 -NetworkSpec $ClusterStretchNetworkSpec -IsEdgeClusterConfiguredForMultiAZ $false -DeployWithoutLicenseKeys $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterStretchSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostSpec = Initialize-VcfHostSpec -Id "MyId" $WitnessSpec = Initialize-VcfWitnessSpec -VsanIp "MyVsanIp" -Fqdn "MyFqdn" -VsanCidr "MyVsanCidr" $ClusterStretchSpec = Initialize-VcfClusterStretchSpec -HostSpecs $HostSpec -WitnessSpec $WitnessSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterStretchSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterStretchSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfWitnessSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterStretchNetworkSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfClusterUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ClusterUpdateSpec</command:noun> <maml:description> <maml:para>Cluster Update Data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Cluster Update Data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfClusterUpdateSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Cluster Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterExpansionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterExpansionSpec</command:parameterValue> <dev:type> <maml:name>ClusterExpansionSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCompactionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCompactionSpec</command:parameterValue> <dev:type> <maml:name>ClusterCompactionSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterStretchSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterStretchSpec</command:parameterValue> <dev:type> <maml:name>ClusterStretchSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterUnstretchSpec</maml:name> <maml:Description> <maml:para>This spec contains the parameters required to convert a Stretched cluster to a Standard vSAN cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MarkForDeletion</maml:name> <maml:Description> <maml:para>Prepare the cluster for deletion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrepareForStretch</maml:name> <maml:Description> <maml:para>Prepare the cluster for stretch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Cluster Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterExpansionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterExpansionSpec</command:parameterValue> <dev:type> <maml:name>ClusterExpansionSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCompactionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCompactionSpec</command:parameterValue> <dev:type> <maml:name>ClusterCompactionSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterStretchSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterStretchSpec</command:parameterValue> <dev:type> <maml:name>ClusterStretchSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterUnstretchSpec</maml:name> <maml:Description> <maml:para>This spec contains the parameters required to convert a Stretched cluster to a Standard vSAN cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MarkForDeletion</maml:name> <maml:Description> <maml:para>Prepare the cluster for deletion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrepareForStretch</maml:name> <maml:Description> <maml:para>Prepare the cluster for stretch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $ClusterExpansionNsxSpec = Initialize-VcfClusterExpansionNsxSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $ClusterExpansionNetworkProfile = Initialize-VcfClusterExpansionNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterExpansionNetworkSpec = Initialize-VcfClusterExpansionNetworkSpec -NsxClusterSpec $ClusterExpansionNsxSpec -NetworkProfiles $ClusterExpansionNetworkProfile $VSANNetworkSpec = Initialize-VcfVSANNetworkSpec -VsanGatewayIP "MyVsanGatewayIP" -VsanCidr "MyVsanCidr" $WitnessSpec = Initialize-VcfWitnessSpec -VsanIp "MyVsanIp" -Fqdn "MyFqdn" -VsanCidr "MyVsanCidr" $ClusterExpansionSpec = Initialize-VcfClusterExpansionSpec -HostSpecs $HostSpec -NetworkSpec $ClusterExpansionNetworkSpec -VsanNetworkSpecs $VSANNetworkSpec -WitnessSpec $WitnessSpec -WitnessTrafficSharedWithVsanTraffic $false -DeployWithoutLicenseKeys $false -InterRackExpansion $false -ForceHostAdditionInPresenceofDeadHosts $false -SkipThumbprintValidation $false $VMNicInfo = Initialize-VcfVMNicInfo -Name "MyName" -LinkSpeedMB 0 -IsInUse $false -IsAutoNegotiateSupported $false -IsActive $false $HostReference = Initialize-VcfHostReference -Id "MyId" -IpAddress "MyIpAddress" -Fqdn "MyFqdn" -VmNics $VMNicInfo -AzName "MyAzName" $ClusterCompactionSpec = Initialize-VcfClusterCompactionSpec -Hosts $HostReference -Force $false -ForceByPassingSafeMinSize $false $NsxStretchClusterSpec = Initialize-VcfNsxStretchClusterSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $StretchClusterNetworkProfile = Initialize-VcfStretchClusterNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $ClusterStretchNetworkSpec = Initialize-VcfClusterStretchNetworkSpec -NsxClusterSpec $NsxStretchClusterSpec -NetworkProfiles $StretchClusterNetworkProfile $ClusterStretchSpec = Initialize-VcfClusterStretchSpec -HostSpecs $HostSpec -WitnessSpec $WitnessSpec -WitnessTrafficSharedWithVsanTraffic $false -VsanNetworkSpecs $VSANNetworkSpec -SecondaryAzOverlayVlanId 0 -NetworkSpec $ClusterStretchNetworkSpec -IsEdgeClusterConfiguredForMultiAZ $false -DeployWithoutLicenseKeys $false $ClusterUpdateSpec = Initialize-VcfClusterUpdateSpec -Name "MyName" -ClusterExpansionSpec $ClusterExpansionSpec -ClusterCompactionSpec $ClusterCompactionSpec -ClusterStretchSpec $ClusterStretchSpec -ClusterUnstretchSpec 0 -MarkForDeletion $false -PrepareForStretch $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ClusterUpdateSpec = Initialize-VcfClusterUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfClusterUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ClusterUpdateSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterExpansionSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterCompactionSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterStretchSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCompatibilityMatrices</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCompatibilityMatrices</command:noun> <maml:description> <maml:para>Get Compatibility Matrices</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Compatibility Matrices</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCompatibilityMatrices</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCompatibilityMatrix</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCompatibilityMatrices </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCompatibilityMatrices with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCompatibilityMatrices </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCompatibilityMatrices with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compatibility-matrices/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCompatibilityMatrix</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCompatibilityMatrix</command:noun> <maml:description> <maml:para>Get Compatibility Matrix</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Compatibility Matrix</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCompatibilityMatrix</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixSource</maml:name> <maml:Description> <maml:para>compatibilityMatrixSource of compatibility data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixSource</maml:name> <maml:Description> <maml:para>compatibilityMatrixSource of compatibility data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CompatibilityMatrix</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCompatibilityMatrix -compatibilityMatrixSource "MycompatibilityMatrixSource" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCompatibilityMatrix with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCompatibilityMatrix -compatibilityMatrixSource "MycompatibilityMatrixSource" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCompatibilityMatrix with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compatibility-matrices/compatibilitymatrixsource/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCompatibilityMatrixContent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCompatibilityMatrixContent</command:noun> <maml:description> <maml:para>Get Compatibility Matrix content</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Compatibility Matrix content</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCompatibilityMatrixContent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixSource</maml:name> <maml:Description> <maml:para>compatibilityMatrixSource of compatibility data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixSource</maml:name> <maml:Description> <maml:para>compatibilityMatrixSource of compatibility data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>string</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCompatibilityMatrixContent -compatibilityMatrixSource "MycompatibilityMatrixSource" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCompatibilityMatrixContent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCompatibilityMatrixContent -compatibilityMatrixSource "MycompatibilityMatrixSource" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCompatibilityMatrixContent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compatibility-matrices/compatibilitymatrixsource/content/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCompatibilityMatrixMetadata</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCompatibilityMatrixMetadata</command:noun> <maml:description> <maml:para>Get Compatibility Matrix Metadata</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Compatibility Matrix Metadata</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCompatibilityMatrixMetadata</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixSource</maml:name> <maml:Description> <maml:para>compatibilityMatrixSource of compatibility data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixSource</maml:name> <maml:Description> <maml:para>compatibilityMatrixSource of compatibility data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CompatibilityMatrixMetadata</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCompatibilityMatrixMetadata -compatibilityMatrixSource "MycompatibilityMatrixSource" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCompatibilityMatrixMetadata with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCompatibilityMatrixMetadata -compatibilityMatrixSource "MycompatibilityMatrixSource" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCompatibilityMatrixMetadata with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compatibility-matrices/compatibilitymatrixsource/metadata/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateCompatibilityMatrix</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateCompatibilityMatrix</command:noun> <maml:description> <maml:para>Update CompatibilityMatrix for a source with JSON file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update CompatibilityMatrix content for a source using a JSON file</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateCompatibilityMatrix</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixSource</maml:name> <maml:Description> <maml:para>Compatibility Matrix Source (VMWARE_COMPAT, VXRAIL_COMPAT)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixContent</maml:name> <maml:Description> <maml:para>Compatibility Matrix Content in JSON File format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixSource</maml:name> <maml:Description> <maml:para>Compatibility Matrix Source (VMWARE_COMPAT, VXRAIL_COMPAT)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompatibilityMatrixContent</maml:name> <maml:Description> <maml:para>Compatibility Matrix Content in JSON File format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfUpdateCompatibilityMatrix -compatibilityMatrixSource "MycompatibilityMatrixSource" -compatibilityMatrixContent </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateCompatibilityMatrix with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfUpdateCompatibilityMatrix -compatibilityMatrixSource "MycompatibilityMatrixSource" -compatibilityMatrixContent </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateCompatibilityMatrix with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compatibility-matrices/put/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfComplianceAudit</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfComplianceAudit</command:noun> <maml:description> <maml:para>Compliance audit of resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Compliance audit of resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfComplianceAudit</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ComplianceAuditSpec</command:parameterValue> <dev:type> <maml:name>ComplianceAuditSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ComplianceAuditSpec</command:parameterValue> <dev:type> <maml:name>ComplianceAuditSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ComplianceTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ComplianceResource = Initialize-VcfComplianceResource -ResourceType "One among: SDDC_MANAGER" -ResourceName "MyResourceName" $ComplianceResourcesConfigurationSpec = Initialize-VcfComplianceResourcesConfigurationSpec -ConfigurationId "MyConfigurationId" -Resources $ComplianceResource $ComplianceAuditSpec = Initialize-VcfComplianceAuditSpec -StandardType "One among: PCI" -StandardVersion "MyStandardVersion" -ComplianceResourcesConfigurationSpec $ComplianceResourcesConfigurationSpec Invoke-VcfComplianceAudit -id "Myid" -complianceAuditSpec $complianceAuditSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfComplianceAudit with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ComplianceResource = Initialize-VcfComplianceResource -ResourceType "One among: SDDC_MANAGER" $ComplianceResourcesConfigurationSpec = Initialize-VcfComplianceResourcesConfigurationSpec -Resources $ComplianceResource $ComplianceAuditSpec = Initialize-VcfComplianceAuditSpec -StandardType "One among: PCI" -StandardVersion "MyStandardVersion" -ComplianceResourcesConfigurationSpec $ComplianceResourcesConfigurationSpec Invoke-VcfComplianceAudit -id "Myid" -complianceAuditSpec $complianceAuditSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfComplianceAudit with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/compliance-audits/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfComplianceAuditSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetComplianceAudit</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetComplianceAudit</command:noun> <maml:description> <maml:para>Get compliance audit</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get compliance audit</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetComplianceAudit</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditId</maml:name> <maml:Description> <maml:para>Compliance Audit ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditId</maml:name> <maml:Description> <maml:para>Compliance Audit ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ComplianceAudit</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAudit -complianceAuditId "MycomplianceAuditId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAudit with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAudit -complianceAuditId "MycomplianceAuditId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAudit with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compliance-audits/complianceauditid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetComplianceAuditForADomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetComplianceAuditForADomain</command:noun> <maml:description> <maml:para>Get compliance audit for a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get compliance audit for a domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetComplianceAuditForADomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditId</maml:name> <maml:Description> <maml:para>Compliance Audit ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditId</maml:name> <maml:Description> <maml:para>Compliance Audit ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ComplianceAudit</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditForADomain -id "Myid" -complianceAuditId "MycomplianceAuditId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditForADomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditForADomain -id "Myid" -complianceAuditId "MycomplianceAuditId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditForADomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/compliance-audits/complianceauditid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetComplianceAuditHistory</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetComplianceAuditHistory</command:noun> <maml:description> <maml:para>Get compliance audit history</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get compliance audit history</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetComplianceAuditHistory</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfComplianceAudit</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditHistory </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditHistory with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditHistory </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditHistory with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compliance-audits/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetComplianceAuditHistoryForADomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetComplianceAuditHistoryForADomain</command:noun> <maml:description> <maml:para>Get compliance audit history for a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get compliance audit history for a domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetComplianceAuditHistoryForADomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfComplianceAudit</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditHistoryForADomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditHistoryForADomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditHistoryForADomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditHistoryForADomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/compliance-audits/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetComplianceAuditItems</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetComplianceAuditItems</command:noun> <maml:description> <maml:para>Get compliance audit items</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get compliance audit items</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetComplianceAuditItems</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditId</maml:name> <maml:Description> <maml:para>Compliance Audit ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditId</maml:name> <maml:Description> <maml:para>Compliance Audit ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfComplianceAuditItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditItems -complianceAuditId "MycomplianceAuditId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditItems with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditItems -complianceAuditId "MycomplianceAuditId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditItems with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compliance-audits/complianceauditid/compliance-audit-items/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetComplianceAuditItemsForADomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetComplianceAuditItemsForADomain</command:noun> <maml:description> <maml:para>Get compliance audit items for a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get compliance audit items for a domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetComplianceAuditItemsForADomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditId</maml:name> <maml:Description> <maml:para>Compliance Audit ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceAuditId</maml:name> <maml:Description> <maml:para>Compliance Audit ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfComplianceAuditItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditItemsForADomain -id "Myid" -complianceAuditId "MycomplianceAuditId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditItemsForADomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditItemsForADomain -id "Myid" -complianceAuditId "MycomplianceAuditId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditItemsForADomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/compliance-audits/complianceauditid/compliance-audit-items/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetComplianceAuditTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetComplianceAuditTask</command:noun> <maml:description> <maml:para>Get compliance audit task</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get compliance audit task</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetComplianceAuditTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Audit task ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Audit task ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ComplianceTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditTask -id "Myid" -taskId "MytaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceAuditTask -id "Myid" -taskId "MytaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceAuditTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/compliance-audits/tasks/taskid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetComplianceConfigurations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetComplianceConfigurations</command:noun> <maml:description> <maml:para>Get all compliance configurations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all compliance configurations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetComplianceConfigurations</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandardType</maml:name> <maml:Description> <maml:para>The standard type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandardVersion</maml:name> <maml:Description> <maml:para>The standard version, use in combination with standardType</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>The resource type One among: SDDC_MANAGER</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceVersion</maml:name> <maml:Description> <maml:para>The resource version, use in combination with resourceType)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandardType</maml:name> <maml:Description> <maml:para>The standard type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandardVersion</maml:name> <maml:Description> <maml:para>The standard version, use in combination with standardType</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>The resource type One among: SDDC_MANAGER</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceVersion</maml:name> <maml:Description> <maml:para>The resource version, use in combination with resourceType)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfComplianceConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceConfigurations -standardType "MystandardType" -standardVersion "MystandardVersion" -resourceType "MyresourceType" -resourceVersion "MyresourceVersion" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceConfigurations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceConfigurations </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceConfigurations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compliance-configurations/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetComplianceStandards</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetComplianceStandards</command:noun> <maml:description> <maml:para>Get all compliance standards</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all compliance standards</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetComplianceStandards</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfComplianceStandard</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceStandards </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceStandards with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetComplianceStandards </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetComplianceStandards with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/compliance-standards/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRetryComplianceAuditTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRetryComplianceAuditTask</command:noun> <maml:description> <maml:para>Retry compliance audit task</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retry compliance audit task</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRetryComplianceAuditTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Audit task ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Audit task ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ComplianceTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRetryComplianceAuditTask -id "Myid" -taskId "MytaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRetryComplianceAuditTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRetryComplianceAuditTask -id "Myid" -taskId "MytaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRetryComplianceAuditTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/compliance-audits/tasks/taskid/patch/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfComplianceAuditSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ComplianceAuditSpec</command:noun> <maml:description> <maml:para>This specification contains compliance to be audited</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains compliance to be audited</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfComplianceAuditSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandardType</maml:name> <maml:Description> <maml:para>Compliance standard type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandardVersion</maml:name> <maml:Description> <maml:para>Compliance standard version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceResourcesConfigurationSpec</maml:name> <maml:Description> <maml:para>Compliance resource and configuration spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ComplianceResourcesConfigurationSpec></command:parameterValue> <dev:type> <maml:name>List<ComplianceResourcesConfigurationSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandardType</maml:name> <maml:Description> <maml:para>Compliance standard type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandardVersion</maml:name> <maml:Description> <maml:para>Compliance standard version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComplianceResourcesConfigurationSpec</maml:name> <maml:Description> <maml:para>Compliance resource and configuration spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ComplianceResourcesConfigurationSpec></command:parameterValue> <dev:type> <maml:name>List<ComplianceResourcesConfigurationSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ComplianceResource = Initialize-VcfComplianceResource -ResourceType "One among: SDDC_MANAGER" -ResourceName "MyResourceName" $ComplianceResourcesConfigurationSpec = Initialize-VcfComplianceResourcesConfigurationSpec -ConfigurationId "MyConfigurationId" -Resources $ComplianceResource $ComplianceAuditSpec = Initialize-VcfComplianceAuditSpec -StandardType "One among: PCI" -StandardVersion "MyStandardVersion" -ComplianceResourcesConfigurationSpec $ComplianceResourcesConfigurationSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComplianceAuditSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ComplianceResource = Initialize-VcfComplianceResource -ResourceType "One among: SDDC_MANAGER" $ComplianceResourcesConfigurationSpec = Initialize-VcfComplianceResourcesConfigurationSpec -Resources $ComplianceResource $ComplianceAuditSpec = Initialize-VcfComplianceAuditSpec -StandardType "One among: PCI" -StandardVersion "MyStandardVersion" -ComplianceResourcesConfigurationSpec $ComplianceResourcesConfigurationSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComplianceAuditSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ComplianceAuditSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfComplianceResource</command:name> <command:verb>Initialize</command:verb> <command:noun>ComplianceResource</command:noun> <maml:description> <maml:para>This specification contains compliance resource details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains compliance resource details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfComplianceResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Compliance Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Compliance Resource FQDN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Compliance Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Compliance Resource FQDN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ComplianceResource = Initialize-VcfComplianceResource -ResourceType "One among: SDDC_MANAGER" -ResourceName "MyResourceName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComplianceResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ComplianceResource = Initialize-VcfComplianceResource -ResourceType "One among: SDDC_MANAGER" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComplianceResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ComplianceResource</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfComplianceResourcesConfigurationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ComplianceResourcesConfigurationSpec</command:noun> <maml:description> <maml:para>This specification contains compliance configuration and resource request details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains compliance configuration and resource request details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfComplianceResourcesConfigurationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigurationId</maml:name> <maml:Description> <maml:para>Compliance configuration id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Compliance Resource details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ComplianceResource></command:parameterValue> <dev:type> <maml:name>List<ComplianceResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigurationId</maml:name> <maml:Description> <maml:para>Compliance configuration id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Compliance Resource details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ComplianceResource></command:parameterValue> <dev:type> <maml:name>List<ComplianceResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ComplianceResource = Initialize-VcfComplianceResource -ResourceType "One among: SDDC_MANAGER" -ResourceName "MyResourceName" $ComplianceResourcesConfigurationSpec = Initialize-VcfComplianceResourcesConfigurationSpec -ConfigurationId "MyConfigurationId" -Resources $ComplianceResource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComplianceResourcesConfigurationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ComplianceResource = Initialize-VcfComplianceResource -ResourceType "One among: SDDC_MANAGER" $ComplianceResourcesConfigurationSpec = Initialize-VcfComplianceResourcesConfigurationSpec -Resources $ComplianceResource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComplianceResourcesConfigurationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ComplianceResourcesConfigurationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfComponentDetails</command:name> <command:verb>Initialize</command:verb> <command:noun>ComponentDetails</command:noun> <maml:description> <maml:para>Component contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Component contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfComponentDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vendor</maml:name> <maml:Description> <maml:para>Component vendor</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>Component display name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayVersion</maml:name> <maml:Description> <maml:para>Component display version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vendor</maml:name> <maml:Description> <maml:para>Component vendor</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>Component display name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayVersion</maml:name> <maml:Description> <maml:para>Component display version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ComponentDetails = Initialize-VcfComponentDetails -Vendor "intel" -DisplayName "MyDisplayName" -DisplayVersion "MyDisplayVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComponentDetails with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ComponentDetails = Initialize-VcfComponentDetails -Vendor "intel" -DisplayName "MyDisplayName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComponentDetails with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ComponentDetails</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfComponentInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>ComponentInfo</command:noun> <maml:description> <maml:para>Component contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Component contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfComponentInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Component Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Details</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ComponentDetails</command:parameterValue> <dev:type> <maml:name>ComponentDetails</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Component Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Details</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ComponentDetails</command:parameterValue> <dev:type> <maml:name>ComponentDetails</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ComponentDetails = Initialize-VcfComponentDetails -Vendor "intel" -DisplayName "MyDisplayName" -DisplayVersion "MyDisplayVersion" $ComponentInfo = Initialize-VcfComponentInfo -_Version "1.3.2.8-1OEM.650.0.0.4598673" -Details $ComponentDetails </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComponentInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ComponentDetails = Initialize-VcfComponentDetails -Vendor "intel" -DisplayName "MyDisplayName" $ComponentInfo = Initialize-VcfComponentInfo -_Version "1.3.2.8-1OEM.650.0.0.4598673" -Details $ComponentDetails </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComponentInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ComponentInfo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfComponentDetails</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfComputeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ComputeSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to add each cluster to a workload domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to add each cluster to a workload domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfComputeSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterSpecs</maml:name> <maml:Description> <maml:para>List of clusters to be added to workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ClusterSpec></command:parameterValue> <dev:type> <maml:name>List<ClusterSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipFailedHosts</maml:name> <maml:Description> <maml:para>Skip failed ESXi Hosts and proceed with the rest of the ESXi Hosts during add Cluster. This is not supported for VCF VxRail.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterSpecs</maml:name> <maml:Description> <maml:para>List of clusters to be added to workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ClusterSpec></command:parameterValue> <dev:type> <maml:name>List<ClusterSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipFailedHosts</maml:name> <maml:Description> <maml:para>Skip failed ESXi Hosts and proceed with the rest of the ESXi Hosts during add Cluster. This is not supported for VCF VxRail.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec -SkipFailedHosts $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComputeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostSpec = Initialize-VcfHostSpec -Id "MyId" $DatastoreSpec = Initialize-VcfDatastoreSpec $NetworkSpec = Initialize-VcfNetworkSpec $ClusterSpec = Initialize-VcfClusterSpec -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfComputeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ComputeSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfConfigDriftApplySpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ConfigDriftApplySpec</command:noun> <maml:description> <maml:para>Describes Configuration Reconciliation operations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Describes Configuration Reconciliation operations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfConfigDriftApplySpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReconciliationForResources</maml:name> <maml:Description> <maml:para>List of Configuration Reconciliation for resource, mutually exclusive with reconciliationForDrifts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ReconciliationForResource></command:parameterValue> <dev:type> <maml:name>List<ReconciliationForResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReconciliationForResources</maml:name> <maml:Description> <maml:para>List of Configuration Reconciliation for resource, mutually exclusive with reconciliationForDrifts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ReconciliationForResource></command:parameterValue> <dev:type> <maml:name>List<ReconciliationForResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ReconciliationForResource = Initialize-VcfReconciliationForResource -ResourceId "Could be ID of domain or a nested child resource eg cluster, host etc." -ApplyAll $false $ConfigDriftApplySpec = Initialize-VcfConfigDriftApplySpec -ReconciliationForResources $ReconciliationForResource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfConfigDriftApplySpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ConfigDriftApplySpec = Initialize-VcfConfigDriftApplySpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfConfigDriftApplySpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ConfigDriftApplySpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetConfigs</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetConfigs</command:noun> <maml:description> <maml:para>Get configs associated with the given criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get configs associated with the given criteria, all if no criteria is provided</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetConfigs</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigId</maml:name> <maml:Description> <maml:para>Config Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DriftType</maml:name> <maml:Description> <maml:para>Drift Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Size</maml:name> <maml:Description> <maml:para>Size of the page to retrieve. Default page size is 10. Optional</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number to retrieve. Default page 0 will retrieve all elements. Optional</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigId</maml:name> <maml:Description> <maml:para>Config Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DriftType</maml:name> <maml:Description> <maml:para>Drift Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Size</maml:name> <maml:Description> <maml:para>Size of the page to retrieve. Default page size is 10. Optional</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number to retrieve. Default page 0 will retrieve all elements. Optional</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfConfigDriftSpec</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetConfigs -resourceId "MyresourceId" -resourceType "MyresourceType" -configId "MyconfigId" -driftType "MydriftType" -size 56 -page 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetConfigs with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetConfigs </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetConfigs with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/config-drifts/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetReconciliationTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetReconciliationTask</command:noun> <maml:description> <maml:para>Get config reconciliation task associated with the given task Id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get config reconciliation task associated with the given task Id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetReconciliationTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Task Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Task Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetReconciliationTask -taskId "MytaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetReconciliationTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetReconciliationTask -taskId "MytaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetReconciliationTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/config-drift-reconciliations/taskid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfReconcileConfigs</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfReconcileConfigs</command:noun> <maml:description> <maml:para>Reconcile configs</maml:para> </maml:description> </command:details> <maml:description> <maml:para>For selective reconciliation, provide a config spec.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfReconcileConfigs</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigDriftApplySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ConfigDriftApplySpec</command:parameterValue> <dev:type> <maml:name>ConfigDriftApplySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigDriftApplySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ConfigDriftApplySpec</command:parameterValue> <dev:type> <maml:name>ConfigDriftApplySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ReconciliationForResource = Initialize-VcfReconciliationForResource -ResourceId "Could be ID of domain or a nested child resource eg cluster, host etc." -ApplyAll $false $ConfigDriftApplySpec = Initialize-VcfConfigDriftApplySpec -ReconciliationForResources $ReconciliationForResource Invoke-VcfReconcileConfigs -configDriftApplySpec $configDriftApplySpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfReconcileConfigs with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ConfigDriftApplySpec = Initialize-VcfConfigDriftApplySpec Invoke-VcfReconcileConfigs -configDriftApplySpec $configDriftApplySpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfReconcileConfigs with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/config-drift-reconciliations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfConfigDriftApplySpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-VcfSddcManagerServer</command:name> <command:verb>Connect</command:verb> <command:noun>VcfSddcManagerServer</command:noun> <maml:description> <maml:para>This cmdlet establishes a connection to a VMware SDDC Manager Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet establishes a connection to a VMware SDDC Manager Server. The resulting connections are added to the list of default connections in a global variable named "$global:defaultSddcManagerConnections" (if the NotDefault switch was not specified).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-VcfSddcManagerServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the IP address or fully qualified domain name (FQDN) of the VMware SDDC Manager Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Username"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user name to log in to the VMware SDDC Manager Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password to log in to the VMware SDDC Manager Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies the credentials to log in to the VMware SDDC Manager Server. You can use this parameter as an alternative to the User/Password parameter pair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IgnoreInvalidCertificate</maml:name> <maml:description> <maml:para>If specified, PowerCLI ignores any errors related to invalid server certificates of the VMware SDDC Manager Server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotDefault</maml:name> <maml:description> <maml:para>If specified, the resulting connection is not recorded in the list of default VMware SDDC Manager server connections and must be manually specified when you use a cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on the server you want to use for the connection. If not specified, a protocol-specific default value is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>Specifies the Internet protocol you want to use for the connection. It can be either HTTP or HTTPS. If not specified, HTTPS is used.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">http</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">https</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the IP address or fully qualified domain name (FQDN) of the VMware SDDC Manager Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Username"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user name to log in to the VMware SDDC Manager Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password to log in to the VMware SDDC Manager Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies the credentials to log in to the VMware SDDC Manager Server. You can use this parameter as an alternative to the User/Password parameter pair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IgnoreInvalidCertificate</maml:name> <maml:description> <maml:para>If specified, PowerCLI ignores any errors related to invalid server certificates of the VMware SDDC Manager Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotDefault</maml:name> <maml:description> <maml:para>If specified, the resulting connection is not recorded in the list of default VMware SDDC Manager server connections and must be manually specified when you use a cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port on the server you want to use for the connection. If not specified, a protocol-specific default value is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>Specifies the Internet protocol you want to use for the connection. It can be either HTTP or HTTPS. If not specified, HTTPS is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Sdk.Vcf.SddcManager.IAccessTokenConnection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Connect-VcfSddcManagerServer -Server MySDDCManager.com -User "User" -Password "Password" Connects to a VMware SDDC Manager server with a MySDDCManager.com address by passing a valid user name and password.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $myCredential = Get-Credential PS C:\> Connect-VcfSddcManagerServer -Server MySDDCManager.com -Credential $myCredential Connects to a VMware SDDC Manager server with a MySDDCManager.com address by passing a credential object.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCancelCredentialsTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCancelCredentialsTask</command:noun> <maml:description> <maml:para>Cancel a failed credential task by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Cancel a failed credential task by its ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCancelCredentialsTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task ID of the failed operation required to be cancelled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task ID of the failed operation required to be cancelled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfCancelCredentialsTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCancelCredentialsTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfCancelCredentialsTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCancelCredentialsTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/tasks/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCredential</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCredential</command:noun> <maml:description> <maml:para>Retrieve a credential by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a credential by its ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the credential</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the credential</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Credential</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredential -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredential -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCredentialTaskByResourceID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCredentialTaskByResourceID</command:noun> <maml:description> <maml:para>Retriece a credential taks by resource ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retriece a credential taks by resource ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCredentialTaskByResourceID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the credentials task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the credentials task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<ResourceCredentials></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentialTaskByResourceID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentialTaskByResourceID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentialTaskByResourceID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentialTaskByResourceID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/tasks/id/resource-credentials/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCredentials</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCredentials</command:noun> <maml:description> <maml:para>Retrieve a list of credentials</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a list of credentials</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCredentials</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>The name of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIp</maml:name> <maml:Description> <maml:para>The IP address of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>The type of the resource. One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>The name of the domain to which the resource belongs to (may be null in case there is no associated domain)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageNumber</maml:name> <maml:Description> <maml:para>The page number (must be a positive number), starts with 0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"0"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>The page size (must be a positive number, 0 as page size returns all records in one page</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"0"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AccountType</maml:name> <maml:Description> <maml:para>Type of the account that needs to be fetched by filtering</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>The name of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIp</maml:name> <maml:Description> <maml:para>The IP address of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>The type of the resource. One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>The name of the domain to which the resource belongs to (may be null in case there is no associated domain)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageNumber</maml:name> <maml:Description> <maml:para>The page number (must be a positive number), starts with 0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"0"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>The page size (must be a positive number, 0 as page size returns all records in one page</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"0"</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AccountType</maml:name> <maml:Description> <maml:para>Type of the account that needs to be fetched by filtering</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCredential</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentials -resourceName "MyresourceName" -resourceIp "MyresourceIp" -resourceType "MyresourceType" -domainName "MydomainName" -pageNumber "MypageNumber" -pageSize "MypageSize" -accountType "MyaccountType" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentials with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentials </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentials with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCredentialsSubTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCredentialsSubTask</command:noun> <maml:description> <maml:para>Retrieve a credential sub task by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a credential sub task by its ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCredentialsSubTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the credentials task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubtaskId</maml:name> <maml:Description> <maml:para>The ID of the credentials sub-task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the credentials task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubtaskId</maml:name> <maml:Description> <maml:para>The ID of the credentials sub-task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CredentialsTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentialsSubTask -id "Myid" -subtaskId "MysubtaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentialsSubTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentialsSubTask -id "Myid" -subtaskId "MysubtaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentialsSubTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/tasks/id/subtasks/subtaskid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCredentialsTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCredentialsTask</command:noun> <maml:description> <maml:para>Retrieve a credential task by ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a credential task by ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCredentialsTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the credentials task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the credentials task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CredentialsTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentialsTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentialsTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentialsTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentialsTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/tasks/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCredentialsTasks</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCredentialsTasks</command:noun> <maml:description> <maml:para>Retrieve a list of credential tasks</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a list of credential tasks</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCredentialsTasks</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>The number of elements to be returned in the result</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>The number of elements to be returned in the result</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCredentialsTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentialsTasks -limit 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentialsTasks with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCredentialsTasks </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCredentialsTasks with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/tasks/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetPasswordExpiration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetPasswordExpiration</command:noun> <maml:description> <maml:para>Fetch expiration details of passwords for a list of credentials</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Fetch expiration details of passwords for a list of credentials</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetPasswordExpiration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialsExpirationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CredentialsExpirationSpec</command:parameterValue> <dev:type> <maml:name>CredentialsExpirationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialsExpirationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CredentialsExpirationSpec</command:parameterValue> <dev:type> <maml:name>CredentialsExpirationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CredentialsExpiration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CredentialsExpirationSpec = Initialize-VcfCredentialsExpirationSpec -DomainName "MyDomainName" -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -CredentialIds "MyCredentialIds" Invoke-VcfGetPasswordExpiration -credentialsExpirationSpec $credentialsExpirationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPasswordExpiration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CredentialsExpirationSpec = Initialize-VcfCredentialsExpirationSpec -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" Invoke-VcfGetPasswordExpiration -credentialsExpirationSpec $credentialsExpirationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPasswordExpiration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/expirations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCredentialsExpirationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetPasswordExpirationByTaskID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetPasswordExpirationByTaskID</command:noun> <maml:description> <maml:para>Retrive a password expiration task by ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrive a password expiration task by ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetPasswordExpirationByTaskID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The expiration fetch workflow ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The expiration fetch workflow ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CredentialsExpiration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetPasswordExpirationByTaskID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPasswordExpirationByTaskID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetPasswordExpirationByTaskID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPasswordExpirationByTaskID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/expirations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRetryCredentialsTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRetryCredentialsTask</command:noun> <maml:description> <maml:para>Retry a failed credentials task for a given ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retry a failed credentials task for a given ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRetryCredentialsTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task ID of the failed operation that is to be retried</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialsUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CredentialsUpdateSpec</command:parameterValue> <dev:type> <maml:name>CredentialsUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task ID of the failed operation that is to be retried</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialsUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CredentialsUpdateSpec</command:parameterValue> <dev:type> <maml:name>CredentialsUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BaseCredential = Initialize-VcfBaseCredential -CredentialType "One among: SSO, SSH, API, FTP, AUDIT" -AccountType "One among: USER, SYSTEM, SERVICE" -Username "MyUsername" -Password "MyPassword" $ResourceCredentials = Initialize-VcfResourceCredentials -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -Credentials $BaseCredential $AutoRotateCredentialPolicyInputSpec = Initialize-VcfAutoRotateCredentialPolicyInputSpec -FrequencyInDays 0 -EnableAutoRotatePolicy $false $CredentialsUpdateSpec = Initialize-VcfCredentialsUpdateSpec -OperationType "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY" -Elements $ResourceCredentials -AutoRotatePolicy $AutoRotateCredentialPolicyInputSpec Invoke-VcfRetryCredentialsTask -id "Myid" -credentialsUpdateSpec $credentialsUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRetryCredentialsTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BaseCredential = Initialize-VcfBaseCredential -Username "MyUsername" $ResourceCredentials = Initialize-VcfResourceCredentials -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -Credentials $BaseCredential $CredentialsUpdateSpec = Initialize-VcfCredentialsUpdateSpec -OperationType "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY" -Elements $ResourceCredentials Invoke-VcfRetryCredentialsTask -id "Myid" -credentialsUpdateSpec $credentialsUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRetryCredentialsTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/tasks/id/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCredentialsUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateOrRotatePasswords</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateOrRotatePasswords</command:noun> <maml:description> <maml:para>Update or rotate passwords for a list of resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update passwords for given list of resources by supplying new passwords or rotate the passwords using system generated passwords</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateOrRotatePasswords</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialsUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CredentialsUpdateSpec</command:parameterValue> <dev:type> <maml:name>CredentialsUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialsUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CredentialsUpdateSpec</command:parameterValue> <dev:type> <maml:name>CredentialsUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BaseCredential = Initialize-VcfBaseCredential -CredentialType "One among: SSO, SSH, API, FTP, AUDIT" -AccountType "One among: USER, SYSTEM, SERVICE" -Username "MyUsername" -Password "MyPassword" $ResourceCredentials = Initialize-VcfResourceCredentials -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -Credentials $BaseCredential $AutoRotateCredentialPolicyInputSpec = Initialize-VcfAutoRotateCredentialPolicyInputSpec -FrequencyInDays 0 -EnableAutoRotatePolicy $false $CredentialsUpdateSpec = Initialize-VcfCredentialsUpdateSpec -OperationType "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY" -Elements $ResourceCredentials -AutoRotatePolicy $AutoRotateCredentialPolicyInputSpec Invoke-VcfUpdateOrRotatePasswords -credentialsUpdateSpec $credentialsUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateOrRotatePasswords with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BaseCredential = Initialize-VcfBaseCredential -Username "MyUsername" $ResourceCredentials = Initialize-VcfResourceCredentials -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -Credentials $BaseCredential $CredentialsUpdateSpec = Initialize-VcfCredentialsUpdateSpec -OperationType "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY" -Elements $ResourceCredentials Invoke-VcfUpdateOrRotatePasswords -credentialsUpdateSpec $credentialsUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateOrRotatePasswords with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/credentials/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCredentialsUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCredentialsExpirationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>CredentialsExpirationSpec</command:noun> <maml:description> <maml:para>This specification contains password expiration fetch request details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains password expiration fetch request details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCredentialsExpirationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Authenticated Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialIds</maml:name> <maml:Description> <maml:para>List of credential ids</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Authenticated Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialIds</maml:name> <maml:Description> <maml:para>List of credential ids</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CredentialsExpirationSpec = Initialize-VcfCredentialsExpirationSpec -DomainName "MyDomainName" -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -CredentialIds "MyCredentialIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCredentialsExpirationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CredentialsExpirationSpec = Initialize-VcfCredentialsExpirationSpec -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCredentialsExpirationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CredentialsExpirationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCredentialsUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>CredentialsUpdateSpec</command:noun> <maml:description> <maml:para>This specification contains password operation request details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains password operation request details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCredentialsUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationType</maml:name> <maml:Description> <maml:para>Operation type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>List of resource credentials to be changed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceCredentials></command:parameterValue> <dev:type> <maml:name>List<ResourceCredentials></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutoRotatePolicy</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AutoRotateCredentialPolicyInputSpec</command:parameterValue> <dev:type> <maml:name>AutoRotateCredentialPolicyInputSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationType</maml:name> <maml:Description> <maml:para>Operation type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>List of resource credentials to be changed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceCredentials></command:parameterValue> <dev:type> <maml:name>List<ResourceCredentials></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutoRotatePolicy</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AutoRotateCredentialPolicyInputSpec</command:parameterValue> <dev:type> <maml:name>AutoRotateCredentialPolicyInputSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BaseCredential = Initialize-VcfBaseCredential -CredentialType "One among: SSO, SSH, API, FTP, AUDIT" -AccountType "One among: USER, SYSTEM, SERVICE" -Username "MyUsername" -Password "MyPassword" $ResourceCredentials = Initialize-VcfResourceCredentials -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -Credentials $BaseCredential $AutoRotateCredentialPolicyInputSpec = Initialize-VcfAutoRotateCredentialPolicyInputSpec -FrequencyInDays 0 -EnableAutoRotatePolicy $false $CredentialsUpdateSpec = Initialize-VcfCredentialsUpdateSpec -OperationType "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY" -Elements $ResourceCredentials -AutoRotatePolicy $AutoRotateCredentialPolicyInputSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCredentialsUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BaseCredential = Initialize-VcfBaseCredential -Username "MyUsername" $ResourceCredentials = Initialize-VcfResourceCredentials -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -Credentials $BaseCredential $CredentialsUpdateSpec = Initialize-VcfCredentialsUpdateSpec -OperationType "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY" -Elements $ResourceCredentials </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCredentialsUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CredentialsUpdateSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfAutoRotateCredentialPolicyInputSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCsrGenerationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>CsrGenerationSpec</command:noun> <maml:description> <maml:para>This specification contains Certificate Signing Request (CSR) details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains Certificate Signing Request (CSR) details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCsrGenerationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Country</maml:name> <maml:Description> <maml:para>ISO 3166 country code where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>The full name of the state where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Locality</maml:name> <maml:Description> <maml:para>The city or locality where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Organization</maml:name> <maml:Description> <maml:para>The name under which company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrganizationUnit</maml:name> <maml:Description> <maml:para>Organization with which the certificate is associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Email</maml:name> <maml:Description> <maml:para>Contact email address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>KeySize</maml:name> <maml:Description> <maml:para>Certificate public key size</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>KeyAlgorithm</maml:name> <maml:Description> <maml:para>The public key algorithm of the certificate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Country</maml:name> <maml:Description> <maml:para>ISO 3166 country code where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>The full name of the state where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Locality</maml:name> <maml:Description> <maml:para>The city or locality where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Organization</maml:name> <maml:Description> <maml:para>The name under which company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrganizationUnit</maml:name> <maml:Description> <maml:para>Organization with which the certificate is associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Email</maml:name> <maml:Description> <maml:para>Contact email address</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>KeySize</maml:name> <maml:Description> <maml:para>Certificate public key size</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>KeyAlgorithm</maml:name> <maml:Description> <maml:para>The public key algorithm of the certificate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CsrGenerationSpec = Initialize-VcfCsrGenerationSpec -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" -Email "admin@vmware.com" -KeySize "One among: 2048, 3072, 4096" -KeyAlgorithm "One among: RSA" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCsrGenerationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CsrGenerationSpec = Initialize-VcfCsrGenerationSpec -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" -KeySize "One among: 2048, 3072, 4096" -KeyAlgorithm "One among: RSA" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCsrGenerationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CsrGenerationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCsrsGenerationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>CsrsGenerationSpec</command:noun> <maml:description> <maml:para>This specification contains CSR Generation request details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains CSR Generation request details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCsrsGenerationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CsrGenerationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CsrGenerationSpec</command:parameterValue> <dev:type> <maml:name>CsrGenerationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Resource(s) in a domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Resource></command:parameterValue> <dev:type> <maml:name>List<Resource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CsrGenerationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CsrGenerationSpec</command:parameterValue> <dev:type> <maml:name>CsrGenerationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>Resource(s) in a domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Resource></command:parameterValue> <dev:type> <maml:name>List<Resource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CsrGenerationSpec = Initialize-VcfCsrGenerationSpec -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" -Email "admin@vmware.com" -KeySize "One among: 2048, 3072, 4096" -KeyAlgorithm "One among: RSA" $Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Fqdn "sfo-vc01.rainpole.io" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" -Name "MyName" -Sans "sfo-vc01.rainpole.io" $CsrsGenerationSpec = Initialize-VcfCsrsGenerationSpec -CsrGenerationSpec $CsrGenerationSpec -Resources $Resource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCsrsGenerationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CsrGenerationSpec = Initialize-VcfCsrGenerationSpec -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" -KeySize "One among: 2048, 3072, 4096" -KeyAlgorithm "One among: RSA" $CsrsGenerationSpec = Initialize-VcfCsrsGenerationSpec -CsrGenerationSpec $CsrGenerationSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCsrsGenerationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CsrsGenerationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCsrGenerationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteCustomIsoById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteCustomIsoById</command:noun> <maml:description> <maml:para>Delete the Custom ISO based on ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete the Custom ISO based on ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteCustomIsoById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoId</maml:name> <maml:Description> <maml:para>custom ISO image ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoId</maml:name> <maml:Description> <maml:para>custom ISO image ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteCustomIsoById -customIsoId "MycustomIsoId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteCustomIsoById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteCustomIsoById -customIsoId "MycustomIsoId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteCustomIsoById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/custom-isos/custom_iso_id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCustomIsoById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCustomIsoById</command:noun> <maml:description> <maml:para>Get the Custom ISO based on ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Custom ISO based matching the ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCustomIsoById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoId</maml:name> <maml:Description> <maml:para>Custom ISO ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoId</maml:name> <maml:Description> <maml:para>Custom ISO ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomIso</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCustomIsoById -customIsoId "MycustomIsoId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCustomIsoById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCustomIsoById -customIsoId "MycustomIsoId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCustomIsoById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/custom-isos/custom_iso_id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCustomIsos</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCustomIsos</command:noun> <maml:description> <maml:para>Get the Custom ISOs</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all Custom ISOs or Custom ISOs that match specified parameters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCustomIsos</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the Custom ISO</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vendor</maml:name> <maml:Description> <maml:para>The vendor name of the Custom ISO</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>The domain resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVersion</maml:name> <maml:Description> <maml:para>The ESXi target version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the Custom ISO</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vendor</maml:name> <maml:Description> <maml:para>The vendor name of the Custom ISO</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>The domain resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVersion</maml:name> <maml:Description> <maml:para>The ESXi target version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfCustomIso</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCustomIsos -name "Myname" -vendor "Myvendor" -domainId "MydomainId" -targetVersion "MytargetVersion" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCustomIsos with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCustomIsos </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCustomIsos with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/custom-isos/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRenameCustomIsoById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRenameCustomIsoById</command:noun> <maml:description> <maml:para>Rename the Custom ISO corresponding to the ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Rename the Custom ISO corresponding to the ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRenameCustomIsoById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoId</maml:name> <maml:Description> <maml:para>Custom ISO ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoRenameSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CustomIsoRenameSpec</command:parameterValue> <dev:type> <maml:name>CustomIsoRenameSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoId</maml:name> <maml:Description> <maml:para>Custom ISO ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoRenameSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CustomIsoRenameSpec</command:parameterValue> <dev:type> <maml:name>CustomIsoRenameSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CustomIso</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CustomIsoRenameSpec = Initialize-VcfCustomIsoRenameSpec -Name "MyName" Invoke-VcfRenameCustomIsoById -customIsoId "MycustomIsoId" -customIsoRenameSpec $customIsoRenameSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRenameCustomIsoById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CustomIsoRenameSpec = Initialize-VcfCustomIsoRenameSpec -Name "MyName" Invoke-VcfRenameCustomIsoById -customIsoId "MycustomIsoId" -customIsoRenameSpec $customIsoRenameSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRenameCustomIsoById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/custom-isos/custom_iso_id/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCustomIsoRenameSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUploadCustomIso</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUploadCustomIso</command:noun> <maml:description> <maml:para>Upload a Custom ISO</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upload Custom ISO to SDDC Manager</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUploadCustomIso</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>File</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>File</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfUploadCustomIso -name "Myname" -file </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadCustomIso with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfUploadCustomIso -name "Myname" -file </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadCustomIso with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/custom-isos/file/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCustomIsoRenameSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>CustomIsoRenameSpec</command:noun> <maml:description> <maml:para>Custom Iso rename spec contains the name field in which the new name is to be entered</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Custom Iso rename spec contains the name field in which the new name is to be entered</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCustomIsoRenameSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Custom Iso name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Custom Iso name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CustomIsoRenameSpec = Initialize-VcfCustomIsoRenameSpec -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCustomIsoRenameSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CustomIsoRenameSpec = Initialize-VcfCustomIsoRenameSpec -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCustomIsoRenameSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CustomIsoRenameSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfCustomISOSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>CustomISOSpec</command:noun> <maml:description> <maml:para>Custom ISO Specifications for VUM Clusters Upgrade with Custom ISO</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Custom ISO Specifications for VUM Clusters Upgrade with Custom ISO</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfCustomISOSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Custom ISO Id for VUM Clusters Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Custom ISO Id for VUM Clusters Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CustomISOSpec = Initialize-VcfCustomISOSpec -Id "MyId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCustomISOSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CustomISOSpec = Initialize-VcfCustomISOSpec -Id "MyId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfCustomISOSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/CustomISOSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDatastoreCriterion</command:name> <command:verb>Initialize</command:verb> <command:noun>DatastoreCriterion</command:noun> <maml:description> <maml:para>Represents a criterion for querying the datastores</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a criterion for querying the datastores</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDatastoreCriterion</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion for querying datastores</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion for querying datastores</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DatastoreCriterion = Initialize-VcfDatastoreCriterion -Name "One among: VSAN_REMOTE_DATASTORES" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDatastoreCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastoreCriterion = Initialize-VcfDatastoreCriterion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDatastoreCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DatastoreCriterion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDatastoreMountSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>DatastoreMountSpec</command:noun> <maml:description> <maml:para>Datastore Mount Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Datastore Mount Spec</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDatastoreMountSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreSpec</command:parameterValue> <dev:type> <maml:name>DatastoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreSpec</command:parameterValue> <dev:type> <maml:name>DatastoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $DatastoreMountSpec = Initialize-VcfDatastoreMountSpec -DatastoreSpec $DatastoreSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDatastoreMountSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $DatastoreSpec = Initialize-VcfDatastoreSpec $DatastoreMountSpec = Initialize-VcfDatastoreMountSpec -DatastoreSpec $DatastoreSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDatastoreMountSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DatastoreMountSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDatastoreSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDatastoreSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>DatastoreSpec</command:noun> <maml:description> <maml:para>This specification contains cluster storage configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains cluster storage configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDatastoreSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanDatastoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VsanDatastoreSpec</command:parameterValue> <dev:type> <maml:name>VsanDatastoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NfsDatastoreSpecs</maml:name> <maml:Description> <maml:para>Cluster storage configuration for NFS</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NfsDatastoreSpec></command:parameterValue> <dev:type> <maml:name>List<NfsDatastoreSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmfsDatastoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmfsDatastoreSpec</command:parameterValue> <dev:type> <maml:name>VmfsDatastoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VvolDatastoreSpecs</maml:name> <maml:Description> <maml:para>Cluster storage configuration for VVOL</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VvolDatastoreSpec></command:parameterValue> <dev:type> <maml:name>List<VvolDatastoreSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanRemoteDatastoreClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VsanRemoteDatastoreClusterSpec</command:parameterValue> <dev:type> <maml:name>VsanRemoteDatastoreClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanDatastoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VsanDatastoreSpec</command:parameterValue> <dev:type> <maml:name>VsanDatastoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NfsDatastoreSpecs</maml:name> <maml:Description> <maml:para>Cluster storage configuration for NFS</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NfsDatastoreSpec></command:parameterValue> <dev:type> <maml:name>List<NfsDatastoreSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmfsDatastoreSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmfsDatastoreSpec</command:parameterValue> <dev:type> <maml:name>VmfsDatastoreSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VvolDatastoreSpecs</maml:name> <maml:Description> <maml:para>Cluster storage configuration for VVOL</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VvolDatastoreSpec></command:parameterValue> <dev:type> <maml:name>List<VvolDatastoreSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanRemoteDatastoreClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VsanRemoteDatastoreClusterSpec</command:parameterValue> <dev:type> <maml:name>VsanRemoteDatastoreClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDatastoreSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $DatastoreSpec = Initialize-VcfDatastoreSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDatastoreSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DatastoreSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVsanDatastoreSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVmfsDatastoreSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVsanRemoteDatastoreClusterSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDepotAccount</command:name> <command:verb>Initialize</command:verb> <command:noun>DepotAccount</command:noun> <maml:description> <maml:para>VMware Depot Account Information</maml:para> </maml:description> </command:details> <maml:description> <maml:para>VMware Depot Account Information</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDepotAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Depot Username for Access</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Depot Password for Access</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Depot Status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>Message explaining depot status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Depot Username for Access</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Depot Password for Access</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Depot Status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>Message explaining depot status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DepotAccount = Initialize-VcfDepotAccount -Username "MyUsername" -Password "MyPassword" -Status "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL" -Message "MyMessage" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDepotAccount with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DepotAccount = Initialize-VcfDepotAccount -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDepotAccount with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DepotAccount</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDepotConfiguration</command:name> <command:verb>Initialize</command:verb> <command:noun>DepotConfiguration</command:noun> <maml:description> <maml:para>Depot Configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Depot Configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDepotConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsOfflineDepot</maml:name> <maml:Description> <maml:para>Flag indicating if the depot is in offline mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Hostname</maml:name> <maml:Description> <maml:para>IP/Hostname of the depot</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Port of the depot</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsOfflineDepot</maml:name> <maml:Description> <maml:para>Flag indicating if the depot is in offline mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Hostname</maml:name> <maml:Description> <maml:para>IP/Hostname of the depot</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Port of the depot</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DepotConfiguration = Initialize-VcfDepotConfiguration -IsOfflineDepot $false -Hostname "MyHostname" -Port 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDepotConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DepotConfiguration = Initialize-VcfDepotConfiguration -IsOfflineDepot $false -Hostname "MyHostname" -Port 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDepotConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DepotConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDepotSettings</command:name> <command:verb>Initialize</command:verb> <command:noun>DepotSettings</command:noun> <maml:description> <maml:para>VMware Depot Settings. At least one of vmwareAccount, dellEmcSupportAccount or offlineAccount value must be provided</maml:para> </maml:description> </command:details> <maml:description> <maml:para>VMware Depot Settings. At least one of vmwareAccount, dellEmcSupportAccount or offlineAccount value must be provided</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDepotSettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmwareAccount</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotAccount</command:parameterValue> <dev:type> <maml:name>DepotAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DellEmcSupportAccount</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotAccount</command:parameterValue> <dev:type> <maml:name>DepotAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OfflineAccount</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotAccount</command:parameterValue> <dev:type> <maml:name>DepotAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DepotConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotConfiguration</command:parameterValue> <dev:type> <maml:name>DepotConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmwareAccount</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotAccount</command:parameterValue> <dev:type> <maml:name>DepotAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DellEmcSupportAccount</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotAccount</command:parameterValue> <dev:type> <maml:name>DepotAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OfflineAccount</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotAccount</command:parameterValue> <dev:type> <maml:name>DepotAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DepotConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotConfiguration</command:parameterValue> <dev:type> <maml:name>DepotConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DepotAccount = Initialize-VcfDepotAccount -Username "MyUsername" -Password "MyPassword" -Status "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL" -Message "MyMessage" $DepotConfiguration = Initialize-VcfDepotConfiguration -IsOfflineDepot $false -Hostname "MyHostname" -Port 0 $DepotSettings = Initialize-VcfDepotSettings -VmwareAccount $DepotAccount -DellEmcSupportAccount $DepotAccount -OfflineAccount $DepotAccount -DepotConfiguration $DepotConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDepotSettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $DepotSettings = Initialize-VcfDepotSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDepotSettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DepotSettings</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDepotAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDepotAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDepotAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDepotConfiguration</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteDepotSettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteDepotSettings</command:noun> <maml:description> <maml:para>Delete the depot configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete the depot configuration if such is present within VCF.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteDepotSettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DepotType</maml:name> <maml:Description> <maml:para>Depot type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DepotType</maml:name> <maml:Description> <maml:para>Depot type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteDepotSettings -depotType "MydepotType" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteDepotSettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteDepotSettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteDepotSettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/settings/depot/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDepotSettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDepotSettings</command:noun> <maml:description> <maml:para>Retrieve the depot configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the depot configuration. In a fresh setup, this would be empty.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDepotSettings</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DepotSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDepotSettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDepotSettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDepotSettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDepotSettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/settings/depot/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateDepotSettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateDepotSettings</command:noun> <maml:description> <maml:para>Configure the depot credentials</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update depot settings. Depot settings can be updated with VMware Depot account</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateDepotSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DepotSettings</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotSettings</command:parameterValue> <dev:type> <maml:name>DepotSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DepotSettings</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DepotSettings</command:parameterValue> <dev:type> <maml:name>DepotSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DepotSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DepotAccount = Initialize-VcfDepotAccount -Username "MyUsername" -Password "MyPassword" -Status "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL" -Message "MyMessage" $DepotConfiguration = Initialize-VcfDepotConfiguration -IsOfflineDepot $false -Hostname "MyHostname" -Port 0 $DepotSettings = Initialize-VcfDepotSettings -VmwareAccount $DepotAccount -DellEmcSupportAccount $DepotAccount -OfflineAccount $DepotAccount -DepotConfiguration $DepotConfiguration Invoke-VcfUpdateDepotSettings -depotSettings $depotSettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateDepotSettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DepotSettings = Initialize-VcfDepotSettings Invoke-VcfUpdateDepotSettings -depotSettings $depotSettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateDepotSettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/settings/depot/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDepotSettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDnsConfiguration</command:name> <command:verb>Initialize</command:verb> <command:noun>DnsConfiguration</command:noun> <maml:description> <maml:para>DNS Configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>DNS Configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDnsConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsServers</maml:name> <maml:Description> <maml:para>List of DNS servers. A maximum of 2 DNS servers are allowed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<DnsServer></command:parameterValue> <dev:type> <maml:name>List<DnsServer></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsServers</maml:name> <maml:Description> <maml:para>List of DNS servers. A maximum of 2 DNS servers are allowed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<DnsServer></command:parameterValue> <dev:type> <maml:name>List<DnsServer></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DnsServer = Initialize-VcfDnsServer -IpAddress "10.0.0.250" -IsPrimary $false $DnsConfiguration = Initialize-VcfDnsConfiguration -DnsServers $DnsServer </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDnsConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $DnsServer = Initialize-VcfDnsServer -IpAddress "10.0.0.250" -IsPrimary $false $DnsConfiguration = Initialize-VcfDnsConfiguration -DnsServers $DnsServer </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDnsConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DnsConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDnsServer</command:name> <command:verb>Initialize</command:verb> <command:noun>DnsServer</command:noun> <maml:description> <maml:para>DNS server details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>DNS server details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDnsServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP address/FQDN of DNS server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsPrimary</maml:name> <maml:Description> <maml:para>Is DNS server primary</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP address/FQDN of DNS server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsPrimary</maml:name> <maml:Description> <maml:para>Is DNS server primary</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DnsServer = Initialize-VcfDnsServer -IpAddress "10.0.0.250" -IsPrimary $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDnsServer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DnsServer = Initialize-VcfDnsServer -IpAddress "10.0.0.250" -IsPrimary $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDnsServer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DnsServer</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDomainCreationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>DomainCreationSpec</command:noun> <maml:description> <maml:para>Domain Creation Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Domain Creation Spec</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDomainCreationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Name of the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrgName</maml:name> <maml:Description> <maml:para>Organization name of the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VcenterSpec</command:parameterValue> <dev:type> <maml:name>VcenterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComputeSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ComputeSpec</command:parameterValue> <dev:type> <maml:name>ComputeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxTSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTSpec</command:parameterValue> <dev:type> <maml:name>NsxTSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomainSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SsoDomainSpec</command:parameterValue> <dev:type> <maml:name>SsoDomainSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SecuritySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecuritySpec</command:parameterValue> <dev:type> <maml:name>SecuritySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeployWithoutLicenseKeys</maml:name> <maml:Description> <maml:para>Flag that indicates if the deployment should happen without license keys</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Name of the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrgName</maml:name> <maml:Description> <maml:para>Organization name of the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VcenterSpec</command:parameterValue> <dev:type> <maml:name>VcenterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComputeSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ComputeSpec</command:parameterValue> <dev:type> <maml:name>ComputeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxTSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTSpec</command:parameterValue> <dev:type> <maml:name>NsxTSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomainSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SsoDomainSpec</command:parameterValue> <dev:type> <maml:name>SsoDomainSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SecuritySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecuritySpec</command:parameterValue> <dev:type> <maml:name>SecuritySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeployWithoutLicenseKeys</maml:name> <maml:Description> <maml:para>Flag that indicates if the deployment should happen without license keys</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" $VcenterSpec = Initialize-VcfVcenterSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec -RootPassword "MyRootPassword" -DatacenterName "MyDatacenterName" -VmSize "One among:xlarge, large, medium, small, tiny" -StorageSize "One among:lstorage, xlstorage" $UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec -SkipFailedHosts $false $NsxManagerSpec = Initialize-VcfNsxManagerSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec $NsxTSpec = Initialize-VcfNsxTSpec -NsxManagerSpecs $NsxManagerSpec -Vip "MyVip" -VipFqdn "MyVipFqdn" -LicenseKey "MyLicenseKey" -NsxManagerAdminPassword "MyNsxManagerAdminPassword" -NsxManagerAuditPassword "MyNsxManagerAuditPassword" -FormFactor "MyFormFactor" -IpAddressPoolSpec $IpAddressPoolSpec $SsoDomainSpec = Initialize-VcfSsoDomainSpec -SsoDomainPassword "MySsoDomainPassword" -SsoDomainName "MySsoDomainName" $RootCaCerts = Initialize-VcfRootCaCerts -Alias "MyAlias" -CertChain "MyCertChain" $SecuritySpec = Initialize-VcfSecuritySpec -EsxiCertsMode "VMCA" -RootCaCerts $RootCaCerts $DomainCreationSpec = Initialize-VcfDomainCreationSpec -DomainName "MyDomainName" -OrgName "MyOrgName" -VcenterSpec $VcenterSpec -ComputeSpec $ComputeSpec -NsxTSpec $NsxTSpec -SsoDomainSpec $SsoDomainSpec -SecuritySpec $SecuritySpec -DeployWithoutLicenseKeys $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -DnsName "MyDnsName" $VcenterSpec = Initialize-VcfVcenterSpec -NetworkDetailsSpec $NetworkDetailsSpec $HostSpec = Initialize-VcfHostSpec -Id "MyId" $DatastoreSpec = Initialize-VcfDatastoreSpec $NetworkSpec = Initialize-VcfNetworkSpec $ClusterSpec = Initialize-VcfClusterSpec -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec $DomainCreationSpec = Initialize-VcfDomainCreationSpec -VcenterSpec $VcenterSpec -ComputeSpec $ComputeSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DomainCreationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVcenterSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfComputeSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxTSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSsoDomainSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSecuritySpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDomainInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>DomainInfo</command:noun> <maml:description> <maml:para>Information about the assessed domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Information about the assessed domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDomainInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Name of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainType</maml:name> <maml:Description> <maml:para>Type of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(DomainTypeEnum)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Id of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Name of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainType</maml:name> <maml:Description> <maml:para>Type of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(DomainTypeEnum)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Id of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DomainInfo = Initialize-VcfDomainInfo -DomainName "MyDomainName" -DomainType "MANAGEMENT" -DomainId "MyDomainId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DomainInfo = Initialize-VcfDomainInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DomainInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDomainIntegration</command:name> <command:verb>Initialize</command:verb> <command:noun>DomainIntegration</command:noun> <maml:description> <maml:para>This specification contains information related to the existing VMware Aria Operations instance deployment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains information related to the existing VMware Aria Operations instance deployment</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDomainIntegration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>The ID of the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The association status of the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(StatusEnum)</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>The ID of the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The association status of the workload domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(StatusEnum)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DomainIntegration = Initialize-VcfDomainIntegration -DomainId "MyDomainId" -Status "ENABLED" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DomainIntegration = Initialize-VcfDomainIntegration -DomainId "MyDomainId" -Status "ENABLED" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DomainIntegration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDomainRelease</command:name> <command:verb>Initialize</command:verb> <command:noun>DomainRelease</command:noun> <maml:description> <maml:para>Target domain VCF version</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Target domain VCF version</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDomainRelease</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVersion</maml:name> <maml:Description> <maml:para>Target version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVxRailVersion</maml:name> <maml:Description> <maml:para>Target VxRail version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetSddcManagerVersion</maml:name> <maml:Description> <maml:para>Target SDDC Manager version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Patches</maml:name> <maml:Description> <maml:para>Target product release and patch versions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<TargetProductVersion></command:parameterValue> <dev:type> <maml:name>List<TargetProductVersion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVersion</maml:name> <maml:Description> <maml:para>Target version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVxRailVersion</maml:name> <maml:Description> <maml:para>Target VxRail version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetSddcManagerVersion</maml:name> <maml:Description> <maml:para>Target SDDC Manager version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Patches</maml:name> <maml:Description> <maml:para>Target product release and patch versions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<TargetProductVersion></command:parameterValue> <dev:type> <maml:name>List<TargetProductVersion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $TargetProductVersion = Initialize-VcfTargetProductVersion -ProductType "One among: SDDC_MANAGER, ESX, VCENTER, VXRAIL, NSX" -_Version "My_Version" $DomainRelease = Initialize-VcfDomainRelease -TargetVersion "MyTargetVersion" -TargetVxRailVersion "MyTargetVxRailVersion" -TargetSddcManagerVersion "MyTargetSddcManagerVersion" -Patches $TargetProductVersion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainRelease with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $DomainRelease = Initialize-VcfDomainRelease </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainRelease with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DomainRelease</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDomains</command:name> <command:verb>Initialize</command:verb> <command:noun>Domains</command:noun> <maml:description> <maml:para>Domains and Clusters for SOS operation.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Domains and Clusters for SOS operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDomains</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterNames</maml:name> <maml:Description> <maml:para>Clusters for the operation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterNames</maml:name> <maml:Description> <maml:para>Clusters for the operation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Domains = Initialize-VcfDomains -DomainName "MyDomainName" -ClusterNames "MyClusterNames" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomains with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Domains = Initialize-VcfDomains </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomains with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Domains</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAssignTagsToDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAssignTagsToDomain</command:noun> <maml:description> <maml:para>Assign tags to a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAssignTagsToDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagAssignmentResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfAssignTagsToDomain -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAssignTagsToDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfAssignTagsToDomain -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAssignTagsToDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/tags/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfTagsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCreateDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCreateDomain</command:noun> <maml:description> <maml:para>Create a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCreateDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainCreationSpec</command:parameterValue> <dev:type> <maml:name>DomainCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainCreationSpec</command:parameterValue> <dev:type> <maml:name>DomainCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" $VcenterSpec = Initialize-VcfVcenterSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec -RootPassword "MyRootPassword" -DatacenterName "MyDatacenterName" -VmSize "One among:xlarge, large, medium, small, tiny" -StorageSize "One among:lstorage, xlstorage" $UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec -SkipFailedHosts $false $NsxManagerSpec = Initialize-VcfNsxManagerSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec $NsxTSpec = Initialize-VcfNsxTSpec -NsxManagerSpecs $NsxManagerSpec -Vip "MyVip" -VipFqdn "MyVipFqdn" -LicenseKey "MyLicenseKey" -NsxManagerAdminPassword "MyNsxManagerAdminPassword" -NsxManagerAuditPassword "MyNsxManagerAuditPassword" -FormFactor "MyFormFactor" -IpAddressPoolSpec $IpAddressPoolSpec $SsoDomainSpec = Initialize-VcfSsoDomainSpec -SsoDomainPassword "MySsoDomainPassword" -SsoDomainName "MySsoDomainName" $RootCaCerts = Initialize-VcfRootCaCerts -Alias "MyAlias" -CertChain "MyCertChain" $SecuritySpec = Initialize-VcfSecuritySpec -EsxiCertsMode "VMCA" -RootCaCerts $RootCaCerts $DomainCreationSpec = Initialize-VcfDomainCreationSpec -DomainName "MyDomainName" -OrgName "MyOrgName" -VcenterSpec $VcenterSpec -ComputeSpec $ComputeSpec -NsxTSpec $NsxTSpec -SsoDomainSpec $SsoDomainSpec -SecuritySpec $SecuritySpec -DeployWithoutLicenseKeys $false Invoke-VcfCreateDomain -domainCreationSpec $domainCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -DnsName "MyDnsName" $VcenterSpec = Initialize-VcfVcenterSpec -NetworkDetailsSpec $NetworkDetailsSpec $HostSpec = Initialize-VcfHostSpec -Id "MyId" $DatastoreSpec = Initialize-VcfDatastoreSpec $NetworkSpec = Initialize-VcfNetworkSpec $ClusterSpec = Initialize-VcfClusterSpec -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec $DomainCreationSpec = Initialize-VcfDomainCreationSpec -VcenterSpec $VcenterSpec -ComputeSpec $ComputeSpec Invoke-VcfCreateDomain -domainCreationSpec $domainCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDomainCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteDomain</command:noun> <maml:description> <maml:para>Remove a domain if it has been previously initialized for deletion</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteDomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteDomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDomainCreateValidation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDomainCreateValidation</command:noun> <maml:description> <maml:para>Get the status of the validations for domain related operations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the status of given domain create validation workflow by given validation id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDomainCreateValidation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VxRail Domain validation id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VxRail Domain validation id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDomainCreateValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDomainCreateValidation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDomainCreateValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDomainCreateValidation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/validations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetAssignableTagsForDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetAssignableTagsForDomain</command:noun> <maml:description> <maml:para>Get tags assignable to a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetAssignableTagsForDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTag</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetAssignableTagsForDomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetAssignableTagsForDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetAssignableTagsForDomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetAssignableTagsForDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/tags/assignable-tags/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterCriteria</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterCriteria</command:noun> <maml:description> <maml:para>Get all cluster criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterCriteria</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfClusterCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterCriteria -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterCriteria with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterCriteria -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterCriteria with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/clusters/criteria/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterCriterion</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterCriterion</command:noun> <maml:description> <maml:para>Get a criterion to query for cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterCriterion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Criteria Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Criteria Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ClusterCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterCriterion -domainId "MydomainId" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterCriterion -domainId "MydomainId" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/clusters/criteria/name/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClusterQueryResponse</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClusterQueryResponse</command:noun> <maml:description> <maml:para>Get cluster query response</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClusterQueryResponse</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterName</maml:name> <maml:Description> <maml:para>Cluster Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterName</maml:name> <maml:Description> <maml:para>Cluster Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ClusterQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterQueryResponse -domainId "MydomainId" -clusterName "MyclusterName" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterQueryResponse with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClusterQueryResponse -domainId "MydomainId" -clusterName "MyclusterName" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClusterQueryResponse with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/clusters/clustername/queries/queryid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetClustersQueryResponse</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetClustersQueryResponse</command:noun> <maml:description> <maml:para>Get clusters query response</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetClustersQueryResponse</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ClusterQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetClustersQueryResponse -domainId "MydomainId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClustersQueryResponse with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetClustersQueryResponse -domainId "MydomainId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetClustersQueryResponse with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/clusters/queries/queryid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDatastoreCriterion</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDatastoreCriterion</command:noun> <maml:description> <maml:para>Get a criterion to query for datastore</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDatastoreCriterion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Criteria Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Criteria Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DatastoreCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoreCriterion -domainId "MydomainId" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoreCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoreCriterion -domainId "MydomainId" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoreCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/datastores/criteria/name/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDatastoreQueryResponse</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDatastoreQueryResponse</command:noun> <maml:description> <maml:para>Get Datastore query response</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDatastoreQueryResponse</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DatastoreQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoreQueryResponse -domainId "MydomainId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoreQueryResponse with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoreQueryResponse -domainId "MydomainId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoreQueryResponse with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/datastores/queries/queryid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDatastoresCriteria</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDatastoresCriteria</command:noun> <maml:description> <maml:para>Get all datastore criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDatastoresCriteria</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfDatastoreCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoresCriteria -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoresCriteria with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDatastoresCriteria -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDatastoresCriteria with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/datastores/criteria/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDomain</command:noun> <maml:description> <maml:para>Get a domain by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Domain</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDomainEndpoints</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDomainEndpoints</command:noun> <maml:description> <maml:para>Retrieve a list of endpoints or URLs for a domain by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDomainEndpoints</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfEndpoint</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainEndpoints -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainEndpoints with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainEndpoints -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainEndpoints with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/endpoints/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDomainIsolationPrecheckStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDomainIsolationPrecheckStatus</command:noun> <maml:description> <maml:para>Get the status of the Domain Isolation Precheck</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDomainIsolationPrecheckStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrecheckId</maml:name> <maml:Description> <maml:para>Precheck ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrecheckId</maml:name> <maml:Description> <maml:para>Precheck ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IsolationPrecheckResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainIsolationPrecheckStatus -domainId "MydomainId" -precheckId "MyprecheckId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainIsolationPrecheckStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainIsolationPrecheckStatus -domainId "MydomainId" -precheckId "MyprecheckId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainIsolationPrecheckStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/isolation-prechecks/precheckid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDomainTagManagerUrl</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDomainTagManagerUrl</command:noun> <maml:description> <maml:para>Get Domain Tag Manager Url</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDomainTagManagerUrl</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagManagerModel</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainTagManagerUrl -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainTagManagerUrl with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainTagManagerUrl -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainTagManagerUrl with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/tags/tag-manager/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDomainUpdateValidation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDomainUpdateValidation</command:noun> <maml:description> <maml:para>Get the status of the validations for domain related operations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the status of given domain update validation workflow by given validation id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDomainUpdateValidation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VxRail Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ValidationId</maml:name> <maml:Description> <maml:para>VxRail Domain validation id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VxRail Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ValidationId</maml:name> <maml:Description> <maml:para>VxRail Domain validation id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainUpdateValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d -validationId 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainUpdateValidation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainUpdateValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d -validationId 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainUpdateValidation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/validations/validationid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDomains</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDomains</command:noun> <maml:description> <maml:para>Retrieve a list of domains</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDomains</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfDomain</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomains -type MANAGEMENT,VI,VDI </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomains with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomains with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTagsAssignedToDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTagsAssignedToDomain</command:noun> <maml:description> <maml:para>Get tags assigned to a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTagsAssignedToDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTag</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToDomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToDomain -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/tags/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTagsAssignedToDomains</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTagsAssignedToDomains</command:noun> <maml:description> <maml:para>Get tags assigned to all domains</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTagsAssignedToDomains</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTagsForResource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToDomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToDomains with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToDomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToDomains with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/tags/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfPerformDomainIsolationPrecheck</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfPerformDomainIsolationPrecheck</command:noun> <maml:description> <maml:para>Perform Domain Isolation Prechecks</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfPerformDomainIsolationPrecheck</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsolationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IsolationSpec</command:parameterValue> <dev:type> <maml:name>IsolationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsolationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IsolationSpec</command:parameterValue> <dev:type> <maml:name>IsolationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SsoDomainSpec = Initialize-VcfSsoDomainSpec -SsoDomainPassword "MySsoDomainPassword" -SsoDomainName "MySsoDomainName" $IsolationSpec = Initialize-VcfIsolationSpec -SsoDomainSpec $SsoDomainSpec -DomainIdForIsolation "MyDomainIdForIsolation" -WorkloadDomainName "MyWorkloadDomainName" Invoke-VcfPerformDomainIsolationPrecheck -domainId "MydomainId" -isolationSpec $isolationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPerformDomainIsolationPrecheck with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IsolationSpec = Initialize-VcfIsolationSpec Invoke-VcfPerformDomainIsolationPrecheck -domainId "MydomainId" -isolationSpec $isolationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPerformDomainIsolationPrecheck with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/isolation-prechecks/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIsolationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfPostClusterQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfPostClusterQuery</command:noun> <maml:description> <maml:para>Post a cluster query</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfPostClusterQuery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterName</maml:name> <maml:Description> <maml:para>Cluster Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCriterion</command:parameterValue> <dev:type> <maml:name>ClusterCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterName</maml:name> <maml:Description> <maml:para>Cluster Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCriterion</command:parameterValue> <dev:type> <maml:name>ClusterCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ClusterQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ClusterCriterion = Initialize-VcfClusterCriterion -Name "One among: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" Invoke-VcfPostClusterQuery -domainId "MydomainId" -clusterName "MyclusterName" -clusterCriterion $clusterCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostClusterQuery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ClusterCriterion = Initialize-VcfClusterCriterion Invoke-VcfPostClusterQuery -domainId "MydomainId" -clusterName "MyclusterName" -clusterCriterion $clusterCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostClusterQuery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/clusters/clustername/queries/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterCriterion</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfPostClustersQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfPostClustersQuery</command:noun> <maml:description> <maml:para>Post clusters query</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfPostClustersQuery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCriterion</command:parameterValue> <dev:type> <maml:name>ClusterCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterCriterion</command:parameterValue> <dev:type> <maml:name>ClusterCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ClusterQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ClusterCriterion = Initialize-VcfClusterCriterion -Name "One among: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" Invoke-VcfPostClustersQuery -domainId "MydomainId" -clusterCriterion $clusterCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostClustersQuery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ClusterCriterion = Initialize-VcfClusterCriterion Invoke-VcfPostClustersQuery -domainId "MydomainId" -clusterCriterion $clusterCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostClustersQuery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/clusters/queries/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterCriterion</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfPostDatastoreQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfPostDatastoreQuery</command:noun> <maml:description> <maml:para>Post a datastore query</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfPostDatastoreQuery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreCriterion</command:parameterValue> <dev:type> <maml:name>DatastoreCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatastoreCriterion</command:parameterValue> <dev:type> <maml:name>DatastoreCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DatastoreQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DatastoreCriterion = Initialize-VcfDatastoreCriterion -Name "One among: VSAN_REMOTE_DATASTORES" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" Invoke-VcfPostDatastoreQuery -domainId "MydomainId" -datastoreCriterion $datastoreCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostDatastoreQuery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastoreCriterion = Initialize-VcfDatastoreCriterion Invoke-VcfPostDatastoreQuery -domainId "MydomainId" -datastoreCriterion $datastoreCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostDatastoreQuery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/datastores/queries/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDatastoreCriterion</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRemoveTagsFromDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRemoveTagsFromDomain</command:noun> <maml:description> <maml:para>remove Tags From Domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRemoveTagsFromDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagAssignmentResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfRemoveTagsFromDomain -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveTagsFromDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfRemoveTagsFromDomain -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveTagsFromDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/tags/delete/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfTagsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateDomain</command:noun> <maml:description> <maml:para>Update a Domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainUpdateSpec</command:parameterValue> <dev:type> <maml:name>DomainUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainUpdateSpec</command:parameterValue> <dev:type> <maml:name>DomainUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" $NsxManagerSpec = Initialize-VcfNsxManagerSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec $NsxTSpec = Initialize-VcfNsxTSpec -NsxManagerSpecs $NsxManagerSpec -Vip "MyVip" -VipFqdn "MyVipFqdn" -LicenseKey "MyLicenseKey" -NsxManagerAdminPassword "MyNsxManagerAdminPassword" -NsxManagerAuditPassword "MyNsxManagerAuditPassword" -FormFactor "MyFormFactor" -IpAddressPoolSpec $IpAddressPoolSpec $SsoDomainSpec = Initialize-VcfSsoDomainSpec -SsoDomainPassword "MySsoDomainPassword" -SsoDomainName "MySsoDomainName" $IsolationSpec = Initialize-VcfIsolationSpec -SsoDomainSpec $SsoDomainSpec -DomainIdForIsolation "MyDomainIdForIsolation" -WorkloadDomainName "MyWorkloadDomainName" $DomainUpdateSpec = Initialize-VcfDomainUpdateSpec -ClusterSpec $ClusterSpec -NsxTSpec $NsxTSpec -MarkForDeletion $false -Name "MyName" -IsolationSpec $IsolationSpec Invoke-VcfUpdateDomain -id "Myid" -domainUpdateSpec $domainUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DomainUpdateSpec = Initialize-VcfDomainUpdateSpec Invoke-VcfUpdateDomain -id "Myid" -domainUpdateSpec $domainUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDomainUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateDomainCreationSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateDomainCreationSpec</command:noun> <maml:description> <maml:para>Perform validation of the DomainCreationSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateDomainCreationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainCreationSpec</command:parameterValue> <dev:type> <maml:name>DomainCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostsOnly</maml:name> <maml:Description> <maml:para>Validate hosts only</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipHostSwitchValidation</maml:name> <maml:Description> <maml:para>Skips host switch validation when hostOnly=true</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainCreationSpec</command:parameterValue> <dev:type> <maml:name>DomainCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostsOnly</maml:name> <maml:Description> <maml:para>Validate hosts only</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipHostSwitchValidation</maml:name> <maml:Description> <maml:para>Skips host switch validation when hostOnly=true</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" $VcenterSpec = Initialize-VcfVcenterSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec -RootPassword "MyRootPassword" -DatacenterName "MyDatacenterName" -VmSize "One among:xlarge, large, medium, small, tiny" -StorageSize "One among:lstorage, xlstorage" $UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec -SkipFailedHosts $false $NsxManagerSpec = Initialize-VcfNsxManagerSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec $NsxTSpec = Initialize-VcfNsxTSpec -NsxManagerSpecs $NsxManagerSpec -Vip "MyVip" -VipFqdn "MyVipFqdn" -LicenseKey "MyLicenseKey" -NsxManagerAdminPassword "MyNsxManagerAdminPassword" -NsxManagerAuditPassword "MyNsxManagerAuditPassword" -FormFactor "MyFormFactor" -IpAddressPoolSpec $IpAddressPoolSpec $SsoDomainSpec = Initialize-VcfSsoDomainSpec -SsoDomainPassword "MySsoDomainPassword" -SsoDomainName "MySsoDomainName" $RootCaCerts = Initialize-VcfRootCaCerts -Alias "MyAlias" -CertChain "MyCertChain" $SecuritySpec = Initialize-VcfSecuritySpec -EsxiCertsMode "VMCA" -RootCaCerts $RootCaCerts $DomainCreationSpec = Initialize-VcfDomainCreationSpec -DomainName "MyDomainName" -OrgName "MyOrgName" -VcenterSpec $VcenterSpec -ComputeSpec $ComputeSpec -NsxTSpec $NsxTSpec -SsoDomainSpec $SsoDomainSpec -SecuritySpec $SecuritySpec -DeployWithoutLicenseKeys $false Invoke-VcfValidateDomainCreationSpec -domainCreationSpec $domainCreationSpec -hostsOnly $true -skipHostSwitchValidation $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateDomainCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -DnsName "MyDnsName" $VcenterSpec = Initialize-VcfVcenterSpec -NetworkDetailsSpec $NetworkDetailsSpec $HostSpec = Initialize-VcfHostSpec -Id "MyId" $DatastoreSpec = Initialize-VcfDatastoreSpec $NetworkSpec = Initialize-VcfNetworkSpec $ClusterSpec = Initialize-VcfClusterSpec -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec $ComputeSpec = Initialize-VcfComputeSpec -ClusterSpecs $ClusterSpec $DomainCreationSpec = Initialize-VcfDomainCreationSpec -VcenterSpec $VcenterSpec -ComputeSpec $ComputeSpec Invoke-VcfValidateDomainCreationSpec -domainCreationSpec $domainCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateDomainCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDomainCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateDomainUpdateSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateDomainUpdateSpec</command:noun> <maml:description> <maml:para>Perform validation of the DomainUpdateSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateDomainUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainUpdateSpec</command:parameterValue> <dev:type> <maml:name>DomainUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainUpdateSpec</command:parameterValue> <dev:type> <maml:name>DomainUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" $NsxManagerSpec = Initialize-VcfNsxManagerSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec $NsxTSpec = Initialize-VcfNsxTSpec -NsxManagerSpecs $NsxManagerSpec -Vip "MyVip" -VipFqdn "MyVipFqdn" -LicenseKey "MyLicenseKey" -NsxManagerAdminPassword "MyNsxManagerAdminPassword" -NsxManagerAuditPassword "MyNsxManagerAuditPassword" -FormFactor "MyFormFactor" -IpAddressPoolSpec $IpAddressPoolSpec $SsoDomainSpec = Initialize-VcfSsoDomainSpec -SsoDomainPassword "MySsoDomainPassword" -SsoDomainName "MySsoDomainName" $IsolationSpec = Initialize-VcfIsolationSpec -SsoDomainSpec $SsoDomainSpec -DomainIdForIsolation "MyDomainIdForIsolation" -WorkloadDomainName "MyWorkloadDomainName" $DomainUpdateSpec = Initialize-VcfDomainUpdateSpec -ClusterSpec $ClusterSpec -NsxTSpec $NsxTSpec -MarkForDeletion $false -Name "MyName" -IsolationSpec $IsolationSpec Invoke-VcfValidateDomainUpdateSpec -id "Myid" -domainUpdateSpec $domainUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateDomainUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DomainUpdateSpec = Initialize-VcfDomainUpdateSpec Invoke-VcfValidateDomainUpdateSpec -id "Myid" -domainUpdateSpec $domainUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateDomainUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/id/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDomainUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfDomainUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>DomainUpdateSpec</command:noun> <maml:description> <maml:para>Domain Update Data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Domain Update Data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfDomainUpdateSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterSpec</command:parameterValue> <dev:type> <maml:name>ClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxTSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTSpec</command:parameterValue> <dev:type> <maml:name>NsxTSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MarkForDeletion</maml:name> <maml:Description> <maml:para>Enable deletion for the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsolationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IsolationSpec</command:parameterValue> <dev:type> <maml:name>IsolationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterSpec</command:parameterValue> <dev:type> <maml:name>ClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxTSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTSpec</command:parameterValue> <dev:type> <maml:name>NsxTSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MarkForDeletion</maml:name> <maml:Description> <maml:para>Enable deletion for the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsolationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IsolationSpec</command:parameterValue> <dev:type> <maml:name>IsolationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec $DatastoreSpec = Initialize-VcfDatastoreSpec -VsanDatastoreSpec $VsanDatastoreSpec -NfsDatastoreSpecs $NfsDatastoreSpec -VmfsDatastoreSpec $VmfsDatastoreSpec -VvolDatastoreSpecs $VvolDatastoreSpec -VsanRemoteDatastoreClusterSpec $VsanRemoteDatastoreClusterSpec $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile $HighAvailability = Initialize-VcfHighAvailability -Enabled $false $AdvancedOptions = Initialize-VcfAdvancedOptions -EvcMode "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4" -HighAvailability $HighAvailability $ClusterSpec = Initialize-VcfClusterSpec -Name "MyName" -ClusterImageId "MyClusterImageId" -VxRailDetails $VxRailDetails -HostSpecs $HostSpec -DatastoreSpec $DatastoreSpec -NetworkSpec $NetworkSpec -AdvancedOptions $AdvancedOptions -SkipThumbprintValidation $false $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" $NsxManagerSpec = Initialize-VcfNsxManagerSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec $NsxTSpec = Initialize-VcfNsxTSpec -NsxManagerSpecs $NsxManagerSpec -Vip "MyVip" -VipFqdn "MyVipFqdn" -LicenseKey "MyLicenseKey" -NsxManagerAdminPassword "MyNsxManagerAdminPassword" -NsxManagerAuditPassword "MyNsxManagerAuditPassword" -FormFactor "MyFormFactor" -IpAddressPoolSpec $IpAddressPoolSpec $SsoDomainSpec = Initialize-VcfSsoDomainSpec -SsoDomainPassword "MySsoDomainPassword" -SsoDomainName "MySsoDomainName" $IsolationSpec = Initialize-VcfIsolationSpec -SsoDomainSpec $SsoDomainSpec -DomainIdForIsolation "MyDomainIdForIsolation" -WorkloadDomainName "MyWorkloadDomainName" $DomainUpdateSpec = Initialize-VcfDomainUpdateSpec -ClusterSpec $ClusterSpec -NsxTSpec $NsxTSpec -MarkForDeletion $false -Name "MyName" -IsolationSpec $IsolationSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $DomainUpdateSpec = Initialize-VcfDomainUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfDomainUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/DomainUpdateSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfClusterSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxTSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIsolationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfEdgeClusterCreationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>EdgeClusterCreationSpec</command:noun> <maml:description> <maml:para>NSX Edge cluster creation data to be validated</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NSX Edge cluster creation data to be validated</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfEdgeClusterCreationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterName</maml:name> <maml:Description> <maml:para>Name for the edge cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterType</maml:name> <maml:Description> <maml:para>Type of edge cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeRootPassword</maml:name> <maml:Description> <maml:para>Edge Password for root user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeAdminPassword</maml:name> <maml:Description> <maml:para>Edge Password for admin user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeAuditPassword</maml:name> <maml:Description> <maml:para>Edge Password for audit</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeFormFactor</maml:name> <maml:Description> <maml:para>Edge Form Factor</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier0ServicesHighAvailability</maml:name> <maml:Description> <maml:para>High-availability Mode for Tier-0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mtu</maml:name> <maml:Description> <maml:para>Maximum transmission unit</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Asn</maml:name> <maml:Description> <maml:para>ASN to be used for the edge cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeSpecs</maml:name> <maml:Description> <maml:para>Specifications for Edge Node. Number of Edge Nodes cannot exceed 8 if HA mode is ACTIVE-ACTIVE and can not exceed 2 if HA mode is ACTIVE-STANDBY</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxTEdgeNodeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxTEdgeNodeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NewIpAddressPoolSpecs</maml:name> <maml:Description> <maml:para>Specifications for new NSX IP address pool(s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier0RoutingType</maml:name> <maml:Description> <maml:para>Tier 0 Routing type -eg eBGP, Static</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier0Name</maml:name> <maml:Description> <maml:para>Name for the Tier-0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier1Name</maml:name> <maml:Description> <maml:para>Name for the Tier-1</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier1Unhosted</maml:name> <maml:Description> <maml:para>Select whether Tier-1 being created per this spec is hosted on the new Edge cluster or not (default value is false, meaning hosted)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterProfileType</maml:name> <maml:Description> <maml:para>Type of edge cluster profile</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterProfileSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTEdgeClusterProfileSpec</command:parameterValue> <dev:type> <maml:name>NsxTEdgeClusterProfileSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipTepRoutabilityCheck</maml:name> <maml:Description> <maml:para>Set to true to bypass normal ICMP-based check of Edge TEP / host TEP routability (default is false, meaning do check)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransitSubnets</maml:name> <maml:Description> <maml:para>Transit subnet addresses in CIDR notation that are used to assign addresses to logical links connecting Tier-0 and Tier-1s</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InternalTransitSubnets</maml:name> <maml:Description> <maml:para>Subnet addresses in CIDR notation that are used to assign addresses to logical links connecting service routers and distributed routers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterName</maml:name> <maml:Description> <maml:para>Name for the edge cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterType</maml:name> <maml:Description> <maml:para>Type of edge cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeRootPassword</maml:name> <maml:Description> <maml:para>Edge Password for root user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeAdminPassword</maml:name> <maml:Description> <maml:para>Edge Password for admin user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeAuditPassword</maml:name> <maml:Description> <maml:para>Edge Password for audit</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeFormFactor</maml:name> <maml:Description> <maml:para>Edge Form Factor</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier0ServicesHighAvailability</maml:name> <maml:Description> <maml:para>High-availability Mode for Tier-0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mtu</maml:name> <maml:Description> <maml:para>Maximum transmission unit</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Asn</maml:name> <maml:Description> <maml:para>ASN to be used for the edge cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeSpecs</maml:name> <maml:Description> <maml:para>Specifications for Edge Node. Number of Edge Nodes cannot exceed 8 if HA mode is ACTIVE-ACTIVE and can not exceed 2 if HA mode is ACTIVE-STANDBY</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxTEdgeNodeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxTEdgeNodeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NewIpAddressPoolSpecs</maml:name> <maml:Description> <maml:para>Specifications for new NSX IP address pool(s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier0RoutingType</maml:name> <maml:Description> <maml:para>Tier 0 Routing type -eg eBGP, Static</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier0Name</maml:name> <maml:Description> <maml:para>Name for the Tier-0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier1Name</maml:name> <maml:Description> <maml:para>Name for the Tier-1</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier1Unhosted</maml:name> <maml:Description> <maml:para>Select whether Tier-1 being created per this spec is hosted on the new Edge cluster or not (default value is false, meaning hosted)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterProfileType</maml:name> <maml:Description> <maml:para>Type of edge cluster profile</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterProfileSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTEdgeClusterProfileSpec</command:parameterValue> <dev:type> <maml:name>NsxTEdgeClusterProfileSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipTepRoutabilityCheck</maml:name> <maml:Description> <maml:para>Set to true to bypass normal ICMP-based check of Edge TEP / host TEP routability (default is false, meaning do check)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransitSubnets</maml:name> <maml:Description> <maml:para>Transit subnet addresses in CIDR notation that are used to assign addresses to logical links connecting Tier-0 and Tier-1s</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InternalTransitSubnets</maml:name> <maml:Description> <maml:para>Subnet addresses in CIDR notation that are used to assign addresses to logical links connecting service routers and distributed routers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec -Name "MyName" -NsxId "MyNsxId" $BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" -PeerIP "MyPeerIP" -AsnPeer 0 -BgpPeerPassword "MyBgpPeerPassword" -BgpPeers $BgpPeerSpec $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -VmManagementPortgroupVlan 0 -VmManagementPortgroupName "MyVmManagementPortgroupName" -EdgeTepGateway "MyEdgeTepGateway" -EdgeTep1IP "MyEdgeTep1IP" -EdgeTep2IP "MyEdgeTep2IP" -EdgeTepIpAddressPool $EdgeTepIpAddressPoolSpec -EdgeTepVlan 0 -ClusterId "MyClusterId" -InterRackCluster $false -UplinkNetwork $NsxTEdgeUplinkNetwork -FirstNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" -SecondNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $NsxTEdgeClusterProfileSpec = Initialize-VcfNsxTEdgeClusterProfileSpec -EdgeClusterProfileName "MyEdgeClusterProfileName" -BfdAllowedHop 0 -BfdDeclareDeadMultiple 0 -BfdProbeInterval 0 -StandbyRelocationThreshold 0 $EdgeClusterCreationSpec = Initialize-VcfEdgeClusterCreationSpec -EdgeClusterName "MyEdgeClusterName" -EdgeClusterType "One among: NSX-T" -EdgeRootPassword "MyEdgeRootPassword" -EdgeAdminPassword "MyEdgeAdminPassword" -EdgeAuditPassword "MyEdgeAuditPassword" -EdgeFormFactor "One among: XLARGE, LARGE, MEDIUM, SMALL" -Tier0ServicesHighAvailability "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY" -Mtu 0 -Asn 0 -EdgeNodeSpecs $NsxTEdgeNodeSpec -NewIpAddressPoolSpecs $IpAddressPoolSpec -Tier0RoutingType "One among: EBGP, STATIC" -Tier0Name "MyTier0Name" -Tier1Name "MyTier1Name" -Tier1Unhosted $false -EdgeClusterProfileType "One among: DEFAULT, CUSTOM" -EdgeClusterProfileSpec $NsxTEdgeClusterProfileSpec -SkipTepRoutabilityCheck $false -TransitSubnets "MyTransitSubnets" -InternalTransitSubnets "MyInternalTransitSubnets" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeClusterCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -EdgeTepVlan 0 $NsxTEdgeClusterProfileSpec = Initialize-VcfNsxTEdgeClusterProfileSpec -EdgeClusterProfileName "MyEdgeClusterProfileName" -BfdAllowedHop 0 -BfdDeclareDeadMultiple 0 -BfdProbeInterval 0 -StandbyRelocationThreshold 0 $EdgeClusterCreationSpec = Initialize-VcfEdgeClusterCreationSpec -EdgeClusterName "MyEdgeClusterName" -EdgeClusterType "One among: NSX-T" -EdgeRootPassword "MyEdgeRootPassword" -EdgeAdminPassword "MyEdgeAdminPassword" -EdgeAuditPassword "MyEdgeAuditPassword" -EdgeFormFactor "One among: XLARGE, LARGE, MEDIUM, SMALL" -Mtu 0 -EdgeNodeSpecs $NsxTEdgeNodeSpec -EdgeClusterProfileType "One among: DEFAULT, CUSTOM" -EdgeClusterProfileSpec $NsxTEdgeClusterProfileSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeClusterCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/EdgeClusterCreationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxTEdgeClusterProfileSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfEdgeClusterExpansionSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>EdgeClusterExpansionSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to expand a NSX edge cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to expand a NSX edge cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfEdgeClusterExpansionSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeRootPassword</maml:name> <maml:Description> <maml:para>Edge Password for root user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeAdminPassword</maml:name> <maml:Description> <maml:para>Edge Password for admin user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeAuditPassword</maml:name> <maml:Description> <maml:para>Edge Password for audit user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipTepRoutabilityCheck</maml:name> <maml:Description> <maml:para>Set to true to bypass normal ICMP-based check of Edge TEP / host TEP routability (default is false, meaning do check)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeSpecs</maml:name> <maml:Description> <maml:para>Specifications for Edge Node</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxTEdgeNodeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxTEdgeNodeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NewIpAddressPoolSpecs</maml:name> <maml:Description> <maml:para>Specifications for new NSX IP address pool(s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdditionalTier1Names</maml:name> <maml:Description> <maml:para>List of names for the additional Tier-1(s) to be created during expansion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier1Unhosted</maml:name> <maml:Description> <maml:para>Select whether all Tier-1(s) being created per this spec are hosted on the Edge cluster or not (default is false, meaning hosted)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeRootPassword</maml:name> <maml:Description> <maml:para>Edge Password for root user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeAdminPassword</maml:name> <maml:Description> <maml:para>Edge Password for admin user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeAuditPassword</maml:name> <maml:Description> <maml:para>Edge Password for audit user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipTepRoutabilityCheck</maml:name> <maml:Description> <maml:para>Set to true to bypass normal ICMP-based check of Edge TEP / host TEP routability (default is false, meaning do check)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeSpecs</maml:name> <maml:Description> <maml:para>Specifications for Edge Node</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxTEdgeNodeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxTEdgeNodeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NewIpAddressPoolSpecs</maml:name> <maml:Description> <maml:para>Specifications for new NSX IP address pool(s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdditionalTier1Names</maml:name> <maml:Description> <maml:para>List of names for the additional Tier-1(s) to be created during expansion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tier1Unhosted</maml:name> <maml:Description> <maml:para>Select whether all Tier-1(s) being created per this spec are hosted on the Edge cluster or not (default is false, meaning hosted)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec -Name "MyName" -NsxId "MyNsxId" $BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" -PeerIP "MyPeerIP" -AsnPeer 0 -BgpPeerPassword "MyBgpPeerPassword" -BgpPeers $BgpPeerSpec $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -VmManagementPortgroupVlan 0 -VmManagementPortgroupName "MyVmManagementPortgroupName" -EdgeTepGateway "MyEdgeTepGateway" -EdgeTep1IP "MyEdgeTep1IP" -EdgeTep2IP "MyEdgeTep2IP" -EdgeTepIpAddressPool $EdgeTepIpAddressPoolSpec -EdgeTepVlan 0 -ClusterId "MyClusterId" -InterRackCluster $false -UplinkNetwork $NsxTEdgeUplinkNetwork -FirstNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" -SecondNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $EdgeClusterExpansionSpec = Initialize-VcfEdgeClusterExpansionSpec -EdgeNodeRootPassword "MyEdgeNodeRootPassword" -EdgeNodeAdminPassword "MyEdgeNodeAdminPassword" -EdgeNodeAuditPassword "MyEdgeNodeAuditPassword" -SkipTepRoutabilityCheck $false -EdgeNodeSpecs $NsxTEdgeNodeSpec -NewIpAddressPoolSpecs $IpAddressPoolSpec -AdditionalTier1Names "MyAdditionalTier1Names" -Tier1Unhosted $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeClusterExpansionSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -EdgeTepVlan 0 $EdgeClusterExpansionSpec = Initialize-VcfEdgeClusterExpansionSpec -EdgeNodeRootPassword "MyEdgeNodeRootPassword" -EdgeNodeAdminPassword "MyEdgeNodeAdminPassword" -EdgeNodeAuditPassword "MyEdgeNodeAuditPassword" -EdgeNodeSpecs $NsxTEdgeNodeSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeClusterExpansionSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/EdgeClusterExpansionSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfEdgeClusterShrinkageSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>EdgeClusterShrinkageSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to shrink a NSX edge cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to shrink a NSX edge cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfEdgeClusterShrinkageSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeIds</maml:name> <maml:Description> <maml:para>List of VCF Edge Node ID's to be removed for shrinkage.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeIds</maml:name> <maml:Description> <maml:para>List of VCF Edge Node ID's to be removed for shrinkage.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$EdgeClusterShrinkageSpec = Initialize-VcfEdgeClusterShrinkageSpec -EdgeNodeIds "MyEdgeNodeIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeClusterShrinkageSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$EdgeClusterShrinkageSpec = Initialize-VcfEdgeClusterShrinkageSpec -EdgeNodeIds "MyEdgeNodeIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeClusterShrinkageSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/EdgeClusterShrinkageSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfEdgeClusterUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>EdgeClusterUpdateSpec</command:noun> <maml:description> <maml:para>NSX Edge cluster update specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NSX Edge cluster update specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfEdgeClusterUpdateSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterExpansionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterExpansionSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterExpansionSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterShrinkageSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterShrinkageSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterShrinkageSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Operation</maml:name> <maml:Description> <maml:para>Edge cluster operation Type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterExpansionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterExpansionSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterExpansionSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterShrinkageSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterShrinkageSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterShrinkageSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Operation</maml:name> <maml:Description> <maml:para>Edge cluster operation Type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec -Name "MyName" -NsxId "MyNsxId" $BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" -PeerIP "MyPeerIP" -AsnPeer 0 -BgpPeerPassword "MyBgpPeerPassword" -BgpPeers $BgpPeerSpec $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -VmManagementPortgroupVlan 0 -VmManagementPortgroupName "MyVmManagementPortgroupName" -EdgeTepGateway "MyEdgeTepGateway" -EdgeTep1IP "MyEdgeTep1IP" -EdgeTep2IP "MyEdgeTep2IP" -EdgeTepIpAddressPool $EdgeTepIpAddressPoolSpec -EdgeTepVlan 0 -ClusterId "MyClusterId" -InterRackCluster $false -UplinkNetwork $NsxTEdgeUplinkNetwork -FirstNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" -SecondNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $EdgeClusterExpansionSpec = Initialize-VcfEdgeClusterExpansionSpec -EdgeNodeRootPassword "MyEdgeNodeRootPassword" -EdgeNodeAdminPassword "MyEdgeNodeAdminPassword" -EdgeNodeAuditPassword "MyEdgeNodeAuditPassword" -SkipTepRoutabilityCheck $false -EdgeNodeSpecs $NsxTEdgeNodeSpec -NewIpAddressPoolSpecs $IpAddressPoolSpec -AdditionalTier1Names "MyAdditionalTier1Names" -Tier1Unhosted $false $EdgeClusterShrinkageSpec = Initialize-VcfEdgeClusterShrinkageSpec -EdgeNodeIds "MyEdgeNodeIds" $EdgeClusterUpdateSpec = Initialize-VcfEdgeClusterUpdateSpec -EdgeClusterExpansionSpec $EdgeClusterExpansionSpec -EdgeClusterShrinkageSpec $EdgeClusterShrinkageSpec -Operation "One among: EXPANSION, SHRINKAGE" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeClusterUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $EdgeClusterUpdateSpec = Initialize-VcfEdgeClusterUpdateSpec -Operation "One among: EXPANSION, SHRINKAGE" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeClusterUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/EdgeClusterUpdateSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEdgeClusterExpansionSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEdgeClusterShrinkageSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfEdgeTepIpAddressPoolSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>EdgeTepIpAddressPoolSpec</command:noun> <maml:description> <maml:para>This specification indicates which NSX IP pool to use for an Edge node's TEPs</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification indicates which NSX IP pool to use for an Edge node's TEPs</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfEdgeTepIpAddressPoolSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>NSX IP Pool Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxId</maml:name> <maml:Description> <maml:para>NSX IP Pool ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>NSX IP Pool Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxId</maml:name> <maml:Description> <maml:para>NSX IP Pool ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec -Name "MyName" -NsxId "MyNsxId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeTepIpAddressPoolSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEdgeTepIpAddressPoolSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/EdgeTepIpAddressPoolSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfEncryption</command:name> <command:verb>Initialize</command:verb> <command:noun>Encryption</command:noun> <maml:description> <maml:para>Restore Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restore Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfEncryption</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Passphrase</maml:name> <maml:Description> <maml:para>Passphrase</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Passphrase</maml:name> <maml:Description> <maml:para>Passphrase</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEncryption with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEncryption with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Encryption</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfError</command:name> <command:verb>Initialize</command:verb> <command:noun>Error</command:noun> <maml:description> <maml:para>Error response containing a minor error code, a localized error message, a localized remediation message and optionally a reference token to correlate the error with the logs </maml:para> </maml:description> </command:details> <maml:description> <maml:para>Error response containing a minor error code, a localized error message, a localized remediation message and optionally a reference token to correlate the error with the logs </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfError</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorCode</maml:name> <maml:Description> <maml:para>The minor error code</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorType</maml:name> <maml:Description> <maml:para>The error type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>The arguments used to localize the message, Can be used by scripts to automate the error processing.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Context</maml:name> <maml:Description> <maml:para>The error context (e.g. the component where it occurred).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The localized error message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RemediationMessage</maml:name> <maml:Description> <maml:para>The localized remediation error message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Causes</maml:name> <maml:Description> <maml:para>The underlying cause exceptions.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ErrorCause></command:parameterValue> <dev:type> <maml:name>List<ErrorCause></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NestedErrors</maml:name> <maml:Description> <maml:para>The nested errors when the error is a composite one</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Error></command:parameterValue> <dev:type> <maml:name>List<Error></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReferenceToken</maml:name> <maml:Description> <maml:para>A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorCode</maml:name> <maml:Description> <maml:para>The minor error code</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorType</maml:name> <maml:Description> <maml:para>The error type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>The arguments used to localize the message, Can be used by scripts to automate the error processing.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Context</maml:name> <maml:Description> <maml:para>The error context (e.g. the component where it occurred).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The localized error message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RemediationMessage</maml:name> <maml:Description> <maml:para>The localized remediation error message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Causes</maml:name> <maml:Description> <maml:para>The underlying cause exceptions.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ErrorCause></command:parameterValue> <dev:type> <maml:name>List<ErrorCause></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NestedErrors</maml:name> <maml:Description> <maml:para>The nested errors when the error is a composite one</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Error></command:parameterValue> <dev:type> <maml:name>List<Error></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReferenceToken</maml:name> <maml:Description> <maml:para>A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfError with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Error = Initialize-VcfError </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfError with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Error</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfErrorCause</command:name> <command:verb>Initialize</command:verb> <command:noun>ErrorCause</command:noun> <maml:description> <maml:para>Describes a single error cause</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Describes a single error cause</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfErrorCause</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the error cause</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message describing the reason for the error</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the error cause</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message describing the reason for the error</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfErrorCause with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ErrorCause = Initialize-VcfErrorCause </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfErrorCause with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ErrorCause</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfEsaConfig</command:name> <command:verb>Initialize</command:verb> <command:noun>EsaConfig</command:noun> <maml:description> <maml:para>This spec contains cluster vSAN ESA configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This spec contains cluster vSAN ESA configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfEsaConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>vSAN ESA enablement status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanMaxConfig</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VsanMaxConfig</command:parameterValue> <dev:type> <maml:name>VsanMaxConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>vSAN ESA enablement status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanMaxConfig</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VsanMaxConfig</command:parameterValue> <dev:type> <maml:name>VsanMaxConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEsaConfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $EsaConfig = Initialize-VcfEsaConfig -Enabled $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEsaConfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/EsaConfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVsanMaxConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfEsxUpgradeFailureAction</command:name> <command:verb>Initialize</command:verb> <command:noun>EsxUpgradeFailureAction</command:noun> <maml:description> <maml:para>Esx Upgrade failure actions to be taken if host entering maintenance mode failed during esx cluster upgrade</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Esx Upgrade failure actions to be taken if host entering maintenance mode failed during esx cluster upgrade</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfEsxUpgradeFailureAction</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetryDelay</maml:name> <maml:Description> <maml:para>Time to wait before we retry the failed operation in seconds. If action is RETRY, the value should be between 300 and 3600 seconds. If action is FAIL, the value should not be set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetryCount</maml:name> <maml:Description> <maml:para>Number of times to retry the failed operation. If the action is RETRY, the value should be between 3 and 100. If the action is FAIL, the value should not be set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Action</maml:name> <maml:Description> <maml:para>Action to be taken if entering maintenance mode fails for a host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetryDelay</maml:name> <maml:Description> <maml:para>Time to wait before we retry the failed operation in seconds. If action is RETRY, the value should be between 300 and 3600 seconds. If action is FAIL, the value should not be set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetryCount</maml:name> <maml:Description> <maml:para>Number of times to retry the failed operation. If the action is RETRY, the value should be between 3 and 100. If the action is FAIL, the value should not be set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Action</maml:name> <maml:Description> <maml:para>Action to be taken if entering maintenance mode fails for a host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$EsxUpgradeFailureAction = Initialize-VcfEsxUpgradeFailureAction -RetryDelay 0 -RetryCount 0 -Action "FAIL, RETRY" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEsxUpgradeFailureAction with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$EsxUpgradeFailureAction = Initialize-VcfEsxUpgradeFailureAction -RetryDelay 0 -RetryCount 0 -Action "FAIL, RETRY" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEsxUpgradeFailureAction with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/EsxUpgradeFailureAction</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfEsxUpgradeOptionsSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>EsxUpgradeOptionsSpec</command:noun> <maml:description> <maml:para>Options for ESXi upgrade. These are applicable to vSphere Lifecycle Manager Images based upgrade only.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Options for ESXi upgrade. These are applicable to vSphere Lifecycle Manager Images based upgrade only.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfEsxUpgradeOptionsSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsxUpgradeFailureAction</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EsxUpgradeFailureAction</command:parameterValue> <dev:type> <maml:name>EsxUpgradeFailureAction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnforceHclValidation</maml:name> <maml:Description> <maml:para>Flag for enforcing HCL validation for ESXi upgrade, when applicable, to prevent remediation if hardware compatibility issues are found.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableQuickPatch</maml:name> <maml:Description> <maml:para>Flag for enabling quick patch policy for ESXi upgrade, when applicable, to do live remediation and not require full maintenance mode or reboot. This option is only applicable to vLCM based ESXi upgrade.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableQuickboot</maml:name> <maml:Description> <maml:para>Flag for requesting Quick Boot</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EvacuateOfflineVms</maml:name> <maml:Description> <maml:para>Flag for requesting Evacuation of Offline VMs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableHac</maml:name> <maml:Description> <maml:para>Flag for disabling HA admission control on the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableDpm</maml:name> <maml:Description> <maml:para>Flag for disabling DPM on the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PreRemediationPowerAction</maml:name> <maml:Description> <maml:para>Flag for setting VM power state before entering maintenance mode.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsxUpgradeFailureAction</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EsxUpgradeFailureAction</command:parameterValue> <dev:type> <maml:name>EsxUpgradeFailureAction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnforceHclValidation</maml:name> <maml:Description> <maml:para>Flag for enforcing HCL validation for ESXi upgrade, when applicable, to prevent remediation if hardware compatibility issues are found.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableQuickPatch</maml:name> <maml:Description> <maml:para>Flag for enabling quick patch policy for ESXi upgrade, when applicable, to do live remediation and not require full maintenance mode or reboot. This option is only applicable to vLCM based ESXi upgrade.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableQuickboot</maml:name> <maml:Description> <maml:para>Flag for requesting Quick Boot</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EvacuateOfflineVms</maml:name> <maml:Description> <maml:para>Flag for requesting Evacuation of Offline VMs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableHac</maml:name> <maml:Description> <maml:para>Flag for disabling HA admission control on the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableDpm</maml:name> <maml:Description> <maml:para>Flag for disabling DPM on the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PreRemediationPowerAction</maml:name> <maml:Description> <maml:para>Flag for setting VM power state before entering maintenance mode.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $EsxUpgradeFailureAction = Initialize-VcfEsxUpgradeFailureAction -RetryDelay 0 -RetryCount 0 -Action "FAIL, RETRY" $EsxUpgradeOptionsSpec = Initialize-VcfEsxUpgradeOptionsSpec -EsxUpgradeFailureAction $EsxUpgradeFailureAction -EnforceHclValidation $false -EnableQuickPatch $false -EnableQuickboot $false -EvacuateOfflineVms $false -DisableHac $false -DisableDpm $false -PreRemediationPowerAction "POWER_OFF_VMS, SUSPEND_VMS, DO_NOT_CHANGE_VMS_POWER_STATE, SUSPEND_VMS_TO_MEMORY" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEsxUpgradeOptionsSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $EsxUpgradeOptionsSpec = Initialize-VcfEsxUpgradeOptionsSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfEsxUpgradeOptionsSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/EsxUpgradeOptionsSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEsxUpgradeFailureAction</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfFcSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>FcSpec</command:noun> <maml:description> <maml:para>Cluster storage configuration for VMFS on FC</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Cluster storage configuration for VMFS on FC</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfFcSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>Datastore name used for cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>Datastore name used for cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfFcSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfFcSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/FcSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfFederatedIdentityProviderSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>FederatedIdentityProviderSpec</command:noun> <maml:description> <maml:para>The identity management configuration when the provider is via broker federation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The identity management configuration when the provider is via broker federation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfFederatedIdentityProviderSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The user-friendly name for the Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Directory</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentityProviderDirectory</command:parameterValue> <dev:type> <maml:name>IdentityProviderDirectory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OidcSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OidcSpec</command:parameterValue> <dev:type> <maml:name>OidcSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SyncClientTokenTTL</maml:name> <maml:Description> <maml:para>The lifetime in seconds of the sync client bear token, default to 6 months if not specified. This field is deprecated. It is being made as a query parameter in the sync client token generation API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The user-friendly name for the Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Directory</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentityProviderDirectory</command:parameterValue> <dev:type> <maml:name>IdentityProviderDirectory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OidcSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OidcSpec</command:parameterValue> <dev:type> <maml:name>OidcSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SyncClientTokenTTL</maml:name> <maml:Description> <maml:para>The lifetime in seconds of the sync client bear token, default to 6 months if not specified. This field is deprecated. It is being made as a query parameter in the sync client token generation API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IdentityProviderDirectory = Initialize-VcfIdentityProviderDirectory -DirectoryId "MyDirectoryId" -Name "MyName" -DefaultDomain "MyDefaultDomain" -Domains "MyDomains" -FederatedIdpSourceType "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE" $OidcSpec = Initialize-VcfOidcSpec -ClientId "MyClientId" -ClientSecret "MyClientSecret" -DiscoveryEndpoint "MyDiscoveryEndpoint" $FederatedIdentityProviderSpec = Initialize-VcfFederatedIdentityProviderSpec -Name "MyName" -Directory $IdentityProviderDirectory -OidcSpec $OidcSpec -SyncClientTokenTTL 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfFederatedIdentityProviderSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $IdentityProviderDirectory = Initialize-VcfIdentityProviderDirectory -Name "MyName" -DefaultDomain "MyDefaultDomain" -Domains "MyDomains" -FederatedIdpSourceType "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE" $OidcSpec = Initialize-VcfOidcSpec -ClientId "MyClientId" -ClientSecret "MyClientSecret" -DiscoveryEndpoint "MyDiscoveryEndpoint" $FederatedIdentityProviderSpec = Initialize-VcfFederatedIdentityProviderSpec -Name "MyName" -Directory $IdentityProviderDirectory -OidcSpec $OidcSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfFederatedIdentityProviderSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/FederatedIdentityProviderSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIdentityProviderDirectory</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOidcSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetFIPSConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetFIPSConfiguration</command:noun> <maml:description> <maml:para>Retrieve the FIPS configration mode</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve VCF security FIPS mode.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetFIPSConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Fips</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetFIPSConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetFIPSConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetFIPSConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetFIPSConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/security/fips/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCustomPatches</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCustomPatches</command:noun> <maml:description> <maml:para>Retrieve the list of custom patches for BOM products associated with or applicable on a VCF domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Filter applicable patches (current/target vcf releases) per product type per domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCustomPatches</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcfRelease</maml:name> <maml:Description> <maml:para>VCF release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxrailReleaseVersion</maml:name> <maml:Description> <maml:para>Vxrail release version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>Product Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcfRelease</maml:name> <maml:Description> <maml:para>VCF release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxrailReleaseVersion</maml:name> <maml:Description> <maml:para>Vxrail release version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>Product Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>FlexibleProductPatches</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCustomPatches -domainId "MydomainId" -vcfRelease 4.0.1.0 -vxrailReleaseVersion 8.0.100-28093095 -productType HOST </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCustomPatches with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCustomPatches -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCustomPatches with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/domains/domainid/custom-patches/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfFunctionality</command:name> <command:verb>Initialize</command:verb> <command:noun>Functionality</command:noun> <maml:description> <maml:para>Defines a functionality model</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Defines a functionality model</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfFunctionality</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Operation that is represented in machine readable format. The convention is <resource>_<operation></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAllowed</maml:name> <maml:Description> <maml:para>Flag indicating if a given functionality is allowed/disallowed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorMessage</maml:name> <maml:Description> <maml:para>The localized error message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Operation that is represented in machine readable format. The convention is <resource>_<operation></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAllowed</maml:name> <maml:Description> <maml:para>Flag indicating if a given functionality is allowed/disallowed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorMessage</maml:name> <maml:Description> <maml:para>The localized error message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Functionality = Initialize-VcfFunctionality -Type "Sample values: HOST_COMMISSION, HOST_DECOMMISSION" -IsAllowed $true -ErrorMessage "MyErrorMessage" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfFunctionality with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Functionality = Initialize-VcfFunctionality -Type "Sample values: HOST_COMMISSION, HOST_DECOMMISSION" -IsAllowed $true </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfFunctionality with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Functionality</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHardwareSupportInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>HardwareSupportInfo</command:noun> <maml:description> <maml:para>Hardware support contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hardware support contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHardwareSupportInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Packages</maml:name> <maml:Description> <maml:para>Hardware support packages</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, HardwareSupportPackageInfo></command:parameterValue> <dev:type> <maml:name>Dictionary<string, HardwareSupportPackageInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Packages</maml:name> <maml:Description> <maml:para>Hardware support packages</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, HardwareSupportPackageInfo></command:parameterValue> <dev:type> <maml:name>Dictionary<string, HardwareSupportPackageInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $HardwareSupportPackageInfo = Initialize-VcfHardwareSupportPackageInfo -Pkg "MyPkg" -_Version "My_Version" $HardwareSupportInfo = Initialize-VcfHardwareSupportInfo -Packages @{ key_example = $HardwareSupportPackageInfo } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHardwareSupportInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HardwareSupportPackageInfo = Initialize-VcfHardwareSupportPackageInfo -Pkg "MyPkg" -_Version "My_Version" $HardwareSupportInfo = Initialize-VcfHardwareSupportInfo -Packages @{ key_example = $HardwareSupportPackageInfo } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHardwareSupportInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HardwareSupportInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHardwareSupportPackageInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>HardwareSupportPackageInfo</command:noun> <maml:description> <maml:para>Hardware Support Package contains metadata regarding the package, version to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hardware Support Package contains metadata regarding the package, version to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHardwareSupportPackageInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Pkg</maml:name> <maml:Description> <maml:para>Hardware support package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Hardware support package version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Pkg</maml:name> <maml:Description> <maml:para>Hardware support package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Hardware support package version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HardwareSupportPackageInfo = Initialize-VcfHardwareSupportPackageInfo -Pkg "MyPkg" -_Version "My_Version" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHardwareSupportPackageInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HardwareSupportPackageInfo = Initialize-VcfHardwareSupportPackageInfo -Pkg "MyPkg" -_Version "My_Version" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHardwareSupportPackageInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HardwareSupportPackageInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHardwareSupportSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>HardwareSupportSpec</command:noun> <maml:description> <maml:para>Hardware Support Specification for Firmware Upgrade</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hardware Support Specification for Firmware Upgrade</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHardwareSupportSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Hardware Support Manager name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PackageSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PackageSpec</command:parameterValue> <dev:type> <maml:name>PackageSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Hardware Support Manager name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PackageSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PackageSpec</command:parameterValue> <dev:type> <maml:name>PackageSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PackageSpec = Initialize-VcfPackageSpec -Name "MyName" -_Version "My_Version" $HardwareSupportSpec = Initialize-VcfHardwareSupportSpec -Name "MyName" -PackageSpec $PackageSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHardwareSupportSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PackageSpec = Initialize-VcfPackageSpec -Name "MyName" -_Version "My_Version" $HardwareSupportSpec = Initialize-VcfHardwareSupportSpec -Name "MyName" -PackageSpec $PackageSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHardwareSupportSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HardwareSupportSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfPackageSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHealthChecks</command:name> <command:verb>Initialize</command:verb> <command:noun>HealthChecks</command:noun> <maml:description> <maml:para>Sos Health Checks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sos Health Checks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHealthChecks</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServicesHealth</maml:name> <maml:Description> <maml:para>Performs checks on Services health.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NtpHealth</maml:name> <maml:Description> <maml:para>Performs NTP checks for components.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GeneralHealth</maml:name> <maml:Description> <maml:para>Performs some generic health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateHealth</maml:name> <maml:Description> <maml:para>Performs Certificate health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PasswordHealth</maml:name> <maml:Description> <maml:para>Performs Password Expiry checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConnectivityHealth</maml:name> <maml:Description> <maml:para>Performs Connectivity health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComputeHealth</maml:name> <maml:Description> <maml:para>Performs Compute Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageHealth</maml:name> <maml:Description> <maml:para>Performs Storage Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsHealth</maml:name> <maml:Description> <maml:para>Performs DNS Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HardwareCompatibilityHealth</maml:name> <maml:Description> <maml:para>Performs HardwareCompatibilityHealth Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionHealth</maml:name> <maml:Description> <maml:para>Perform version checks for VCF components.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServicesHealth</maml:name> <maml:Description> <maml:para>Performs checks on Services health.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NtpHealth</maml:name> <maml:Description> <maml:para>Performs NTP checks for components.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GeneralHealth</maml:name> <maml:Description> <maml:para>Performs some generic health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateHealth</maml:name> <maml:Description> <maml:para>Performs Certificate health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PasswordHealth</maml:name> <maml:Description> <maml:para>Performs Password Expiry checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConnectivityHealth</maml:name> <maml:Description> <maml:para>Performs Connectivity health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComputeHealth</maml:name> <maml:Description> <maml:para>Performs Compute Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageHealth</maml:name> <maml:Description> <maml:para>Performs Storage Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsHealth</maml:name> <maml:Description> <maml:para>Performs DNS Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HardwareCompatibilityHealth</maml:name> <maml:Description> <maml:para>Performs HardwareCompatibilityHealth Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionHealth</maml:name> <maml:Description> <maml:para>Perform version checks for VCF components.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HealthChecks = Initialize-VcfHealthChecks -ServicesHealth $false -NtpHealth $false -GeneralHealth $false -CertificateHealth $false -PasswordHealth $false -ConnectivityHealth $false -ComputeHealth $false -StorageHealth $false -DnsHealth $false -HardwareCompatibilityHealth $false -VersionHealth $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthChecks with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HealthChecks = Initialize-VcfHealthChecks </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthChecks with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HealthChecks</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHealthCheckSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>HealthCheckSpec</command:noun> <maml:description> <maml:para>HealthCheck</maml:para> </maml:description> </command:details> <maml:description> <maml:para>HealthCheck</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHealthCheckSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Health Check id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Health Check name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Health check status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Name of the resource, if the ResourceType is CLUSTER, then the resourceName == ClusterName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Health Check id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Health Check name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Health check status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Name of the resource, if the ResourceType is CLUSTER, then the resourceName == ClusterName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HealthCheckSpec = Initialize-VcfHealthCheckSpec -Id "MyId" -Name "MyName" -Status "MyStatus" -ResourceType "MyResourceType" -ResourceName "MyResourceName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthCheckSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HealthCheckSpec = Initialize-VcfHealthCheckSpec -Id "MyId" -Name "MyName" -Status "MyStatus" -ResourceType "MyResourceType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthCheckSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HealthCheckSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHealthSummaryConfig</command:name> <command:verb>Initialize</command:verb> <command:noun>HealthSummaryConfig</command:noun> <maml:description> <maml:para>HealthSummary config</maml:para> </maml:description> </command:details> <maml:description> <maml:para>HealthSummary config</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHealthSummaryConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipKnownHostCheck</maml:name> <maml:Description> <maml:para>Skip known_hosts file for HealthSummary.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Run SOS operations, even if there is a Workload running.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipKnownHostCheck</maml:name> <maml:Description> <maml:para>Skip known_hosts file for HealthSummary.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Run SOS operations, even if there is a Workload running.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HealthSummaryConfig = Initialize-VcfHealthSummaryConfig -SkipKnownHostCheck $false -Force $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummaryConfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HealthSummaryConfig = Initialize-VcfHealthSummaryConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummaryConfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HealthSummaryConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHealthSummaryIncludeItems</command:name> <command:verb>Initialize</command:verb> <command:noun>HealthSummaryIncludeItems</command:noun> <maml:description> <maml:para>Sos Additional Reports for Health Checks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sos Additional Reports for Health Checks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHealthSummaryIncludeItems</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SummaryReport</maml:name> <maml:Description> <maml:para>Collect Vcf Summary Reports</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrecheckReport</maml:name> <maml:Description> <maml:para>Collect VCF LCM Upgrade Pre-check Reports, Default value is False</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SummaryReport</maml:name> <maml:Description> <maml:para>Collect Vcf Summary Reports</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrecheckReport</maml:name> <maml:Description> <maml:para>Collect VCF LCM Upgrade Pre-check Reports, Default value is False</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HealthSummaryIncludeItems = Initialize-VcfHealthSummaryIncludeItems -SummaryReport $false -PrecheckReport $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummaryIncludeItems with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HealthSummaryIncludeItems = Initialize-VcfHealthSummaryIncludeItems </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummaryIncludeItems with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HealthSummaryIncludeItems</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHealthSummaryOption</command:name> <command:verb>Initialize</command:verb> <command:noun>HealthSummaryOption</command:noun> <maml:description> <maml:para>Sos options for support health checks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sos options for support health checks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHealthSummaryOption</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Config</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummaryConfig</command:parameterValue> <dev:type> <maml:name>HealthSummaryConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummaryIncludeItems</command:parameterValue> <dev:type> <maml:name>HealthSummaryIncludeItems</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Config</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummaryConfig</command:parameterValue> <dev:type> <maml:name>HealthSummaryConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummaryIncludeItems</command:parameterValue> <dev:type> <maml:name>HealthSummaryIncludeItems</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $HealthSummaryConfig = Initialize-VcfHealthSummaryConfig -SkipKnownHostCheck $false -Force $false $HealthSummaryIncludeItems = Initialize-VcfHealthSummaryIncludeItems -SummaryReport $false -PrecheckReport $false $HealthSummaryOption = Initialize-VcfHealthSummaryOption -Config $HealthSummaryConfig -Include $HealthSummaryIncludeItems </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummaryOption with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HealthSummaryOption = Initialize-VcfHealthSummaryOption </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummaryOption with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HealthSummaryOption</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHealthSummaryConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHealthSummaryIncludeItems</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHealthSummaryScope</command:name> <command:verb>Initialize</command:verb> <command:noun>HealthSummaryScope</command:noun> <maml:description> <maml:para>Domain and cluster under which logs should be collected.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Domain and cluster under which logs should be collected.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHealthSummaryScope</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeFreeHosts</maml:name> <maml:Description> <maml:para>Include free hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeAllDomains</maml:name> <maml:Description> <maml:para>Include all domains for SOS operation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domains</maml:name> <maml:Description> <maml:para>Domains and Clusters for SOS operation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Domains></command:parameterValue> <dev:type> <maml:name>List<Domains></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeFreeHosts</maml:name> <maml:Description> <maml:para>Include free hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeAllDomains</maml:name> <maml:Description> <maml:para>Include all domains for SOS operation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domains</maml:name> <maml:Description> <maml:para>Domains and Clusters for SOS operation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Domains></command:parameterValue> <dev:type> <maml:name>List<Domains></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Domains = Initialize-VcfDomains -DomainName "MyDomainName" -ClusterNames "MyClusterNames" $HealthSummaryScope = Initialize-VcfHealthSummaryScope -IncludeFreeHosts $false -IncludeAllDomains $false -Domains $Domains </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummaryScope with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HealthSummaryScope = Initialize-VcfHealthSummaryScope </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummaryScope with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HealthSummaryScope</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHealthSummarySpec</command:name> <command:verb>Initialize</command:verb> <command:noun>HealthSummarySpec</command:noun> <maml:description> <maml:para>No description available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHealthSummarySpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Options</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummaryOption</command:parameterValue> <dev:type> <maml:name>HealthSummaryOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummaryScope</command:parameterValue> <dev:type> <maml:name>HealthSummaryScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HealthChecks</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthChecks</command:parameterValue> <dev:type> <maml:name>HealthChecks</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Options</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummaryOption</command:parameterValue> <dev:type> <maml:name>HealthSummaryOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummaryScope</command:parameterValue> <dev:type> <maml:name>HealthSummaryScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HealthChecks</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthChecks</command:parameterValue> <dev:type> <maml:name>HealthChecks</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $HealthSummaryConfig = Initialize-VcfHealthSummaryConfig -SkipKnownHostCheck $false -Force $false $HealthSummaryIncludeItems = Initialize-VcfHealthSummaryIncludeItems -SummaryReport $false -PrecheckReport $false $HealthSummaryOption = Initialize-VcfHealthSummaryOption -Config $HealthSummaryConfig -Include $HealthSummaryIncludeItems $Domains = Initialize-VcfDomains -DomainName "MyDomainName" -ClusterNames "MyClusterNames" $HealthSummaryScope = Initialize-VcfHealthSummaryScope -IncludeFreeHosts $false -IncludeAllDomains $false -Domains $Domains $HealthChecks = Initialize-VcfHealthChecks -ServicesHealth $false -NtpHealth $false -GeneralHealth $false -CertificateHealth $false -PasswordHealth $false -ConnectivityHealth $false -ComputeHealth $false -StorageHealth $false -DnsHealth $false -HardwareCompatibilityHealth $false -VersionHealth $false $HealthSummarySpec = Initialize-VcfHealthSummarySpec -Options $HealthSummaryOption -Scope $HealthSummaryScope -HealthChecks $HealthChecks </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummarySpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HealthSummarySpec = Initialize-VcfHealthSummarySpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHealthSummarySpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HealthSummarySpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHealthSummaryOption</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHealthSummaryScope</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHealthChecks</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHighAvailability</command:name> <command:verb>Initialize</command:verb> <command:noun>HighAvailability</command:noun> <maml:description> <maml:para>This specification contains high availability settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains high availability settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHighAvailability</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HighAvailability = Initialize-VcfHighAvailability -Enabled $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHighAvailability with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HighAvailability = Initialize-VcfHighAvailability -Enabled $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHighAvailability with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HighAvailability</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHostCommissionSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>HostCommissionSpec</command:noun> <maml:description> <maml:para> This specification contains the input to commission a host to VMware Cloud Foundation</maml:para> </maml:description> </command:details> <maml:description> <maml:para> This specification contains the input to commission a host to VMware Cloud Foundation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHostCommissionSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>FQDN of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageType</maml:name> <maml:Description> <maml:para>Storage Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VvolStorageProtocolType</maml:name> <maml:Description> <maml:para>vVol Storage Protocol Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkPoolId</maml:name> <maml:Description> <maml:para>ID of the network pool to associate the host with</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkPoolName</maml:name> <maml:Description> <maml:para>Name of the network pool to associate the host with</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshThumbprint</maml:name> <maml:Description> <maml:para>SSH thumbprint of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SslThumbprint</maml:name> <maml:Description> <maml:para>SSL thumbprint of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>FQDN of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageType</maml:name> <maml:Description> <maml:para>Storage Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VvolStorageProtocolType</maml:name> <maml:Description> <maml:para>vVol Storage Protocol Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkPoolId</maml:name> <maml:Description> <maml:para>ID of the network pool to associate the host with</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkPoolName</maml:name> <maml:Description> <maml:para>Name of the network pool to associate the host with</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshThumbprint</maml:name> <maml:Description> <maml:para>SSH thumbprint of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SslThumbprint</maml:name> <maml:Description> <maml:para>SSL thumbprint of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HostCommissionSpec = Initialize-VcfHostCommissionSpec -Fqdn "MyFqdn" -Username "MyUsername" -Password "MyPassword" -StorageType "One among: VSAN, VSAN_ESA, VSAN_REMOTE, VSAN_MAX, NFS, VMFS_FC, VVOL" -VvolStorageProtocolType "One among: ISCSI, NFS, FC" -NetworkPoolId "MyNetworkPoolId" -NetworkPoolName "MyNetworkPoolName" -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostCommissionSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostCommissionSpec = Initialize-VcfHostCommissionSpec -Fqdn "MyFqdn" -Username "MyUsername" -Password "MyPassword" -StorageType "One among: VSAN, VSAN_ESA, VSAN_REMOTE, VSAN_MAX, NFS, VMFS_FC, VVOL" -NetworkPoolId "MyNetworkPoolId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostCommissionSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HostCommissionSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHostCriterion</command:name> <command:verb>Initialize</command:verb> <command:noun>HostCriterion</command:noun> <maml:description> <maml:para>Represents a criterion for querying the host</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a criterion for querying the host</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHostCriterion</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubCriteria</maml:name> <maml:Description> <maml:para>Collection of sub-criterion supported on this criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCriterion></command:parameterValue> <dev:type> <maml:name>List<HostCriterion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubCriteria</maml:name> <maml:Description> <maml:para>Collection of sub-criterion supported on this criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCriterion></command:parameterValue> <dev:type> <maml:name>List<HostCriterion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $HostCriterion = Initialize-VcfHostCriterion -Name "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR, UNMANAGED_HOSTS_IN_HCIMGR_MANUAL_DISCOVERY" -SubCriteria $HostCriterion -Arguments @{ key_example = "MyInner" } -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostCriterion = Initialize-VcfHostCriterion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HostCriterion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHostDecommissionSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>HostDecommissionSpec</command:noun> <maml:description> <maml:para>This specification contains host details required to decommission a host from VMware Cloud Foundation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains host details required to decommission a host from VMware Cloud Foundation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHostDecommissionSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>FQDN of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>FQDN of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HostDecommissionSpec = Initialize-VcfHostDecommissionSpec -Fqdn "MyFqdn" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostDecommissionSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostDecommissionSpec = Initialize-VcfHostDecommissionSpec -Fqdn "MyFqdn" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostDecommissionSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HostDecommissionSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHostNetworkSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>HostNetworkSpec</command:noun> <maml:description> <maml:para>This specification contains network details required when adding a vSphere host to a cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains network details required when adding a vSphere host to a cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHostNetworkSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmNics</maml:name> <maml:Description> <maml:para>List of the vSphere host vmNics</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VmNic></command:parameterValue> <dev:type> <maml:name>List<VmNic></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkProfileName</maml:name> <maml:Description> <maml:para>Network profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmNics</maml:name> <maml:Description> <maml:para>List of the vSphere host vmNics</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VmNic></command:parameterValue> <dev:type> <maml:name>List<VmNic></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkProfileName</maml:name> <maml:Description> <maml:para>Network profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostNetworkSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostNetworkSpec = Initialize-VcfHostNetworkSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostNetworkSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HostNetworkSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHostReference</command:name> <command:verb>Initialize</command:verb> <command:noun>HostReference</command:noun> <maml:description> <maml:para>Represents an ESXi host reference</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents an ESXi host reference</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHostReference</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP address of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>FQDN of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmNics</maml:name> <maml:Description> <maml:para>VM NICs of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMNicInfo></command:parameterValue> <dev:type> <maml:name>List<VMNicInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AzName</maml:name> <maml:Description> <maml:para>Fault domain name of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP address of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>FQDN of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmNics</maml:name> <maml:Description> <maml:para>VM NICs of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMNicInfo></command:parameterValue> <dev:type> <maml:name>List<VMNicInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AzName</maml:name> <maml:Description> <maml:para>Fault domain name of the host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VMNicInfo = Initialize-VcfVMNicInfo -Name "MyName" -LinkSpeedMB 0 -IsInUse $false -IsAutoNegotiateSupported $false -IsActive $false $HostReference = Initialize-VcfHostReference -Id "MyId" -IpAddress "MyIpAddress" -Fqdn "MyFqdn" -VmNics $VMNicInfo -AzName "MyAzName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostReference with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostReference = Initialize-VcfHostReference </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostReference with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HostReference</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAssignTagsToHost</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAssignTagsToHost</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Assign tags to a host</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAssignTagsToHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>Assign tags to a host request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>Assign tags to a host request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagAssignmentResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfAssignTagsToHost -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAssignTagsToHost with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfAssignTagsToHost -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAssignTagsToHost with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/id/tags/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfTagsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCommissionHosts</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCommissionHosts</command:noun> <maml:description> <maml:para>Commission the Hosts</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCommissionHosts</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCommissionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostCommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCommissionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostCommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HostCommissionSpec = Initialize-VcfHostCommissionSpec -Fqdn "MyFqdn" -Username "MyUsername" -Password "MyPassword" -StorageType "One among: VSAN, VSAN_ESA, VSAN_REMOTE, VSAN_MAX, NFS, VMFS_FC, VVOL" -VvolStorageProtocolType "One among: ISCSI, NFS, FC" -NetworkPoolId "MyNetworkPoolId" -NetworkPoolName "MyNetworkPoolName" -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" Invoke-VcfCommissionHosts -hostCommissionSpec $hostCommissionSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCommissionHosts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostCommissionSpec = Initialize-VcfHostCommissionSpec -Fqdn "MyFqdn" -Username "MyUsername" -Password "MyPassword" -StorageType "One among: VSAN, VSAN_ESA, VSAN_REMOTE, VSAN_MAX, NFS, VMFS_FC, VVOL" -NetworkPoolId "MyNetworkPoolId" Invoke-VcfCommissionHosts -hostCommissionSpec $hostCommissionSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCommissionHosts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDecommissionHosts</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDecommissionHosts</command:noun> <maml:description> <maml:para>Decommission the Hosts</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDecommissionHosts</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostDecommissionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostDecommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostDecommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostDecommissionSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostDecommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostDecommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HostDecommissionSpec = Initialize-VcfHostDecommissionSpec -Fqdn "MyFqdn" Invoke-VcfDecommissionHosts -hostDecommissionSpec $hostDecommissionSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDecommissionHosts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostDecommissionSpec = Initialize-VcfHostDecommissionSpec -Fqdn "MyFqdn" Invoke-VcfDecommissionHosts -hostDecommissionSpec $hostDecommissionSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDecommissionHosts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetAssignableTagForHost</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetAssignableTagForHost</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get tags assignable to a host</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetAssignableTagForHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTag</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetAssignableTagForHost -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetAssignableTagForHost with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetAssignableTagForHost -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetAssignableTagForHost with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/id/tags/assignable-tags/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCriteria</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCriteria</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all criteria</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCriteria</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfHostCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCriteria </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCriteria with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCriteria </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCriteria with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/criteria/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetCriterion</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetCriterion</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a criterion</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetCriterion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HostCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetCriterion -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetCriterion -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/criteria/name/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHost</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHost</command:noun> <maml:description> <maml:para>Get a host by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Host</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHost -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHost with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHost -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHost with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHostCommissionValidationByID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHostCommissionValidationByID</command:noun> <maml:description> <maml:para>Retrieve the results of a host commission validation by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHostCommissionValidationByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostCommissionValidationByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostCommissionValidationByID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostCommissionValidationByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostCommissionValidationByID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/validations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHostQueryResponse</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHostQueryResponse</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get query response</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHostQueryResponse</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HostQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostQueryResponse -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostQueryResponse with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostQueryResponse -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostQueryResponse with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/queries/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHostTagManagerUrl</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHostTagManagerUrl</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Host Tag Manager Url</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHostTagManagerUrl</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagManagerModel</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostTagManagerUrl -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostTagManagerUrl with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostTagManagerUrl -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostTagManagerUrl with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/id/tags/tag-manager/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHosts</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHosts</command:noun> <maml:description> <maml:para>Get all hosts</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHosts</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Status of the Host.One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>ID of the Domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>ID of the Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkpoolId</maml:name> <maml:Description> <maml:para>ID of the Network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageType</maml:name> <maml:Description> <maml:para>Type of the Storage.VMFS_FC</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>Name of the datastore</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Status of the Host.One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>ID of the Domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>ID of the Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkpoolId</maml:name> <maml:Description> <maml:para>ID of the Network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageType</maml:name> <maml:Description> <maml:para>Type of the Storage.VMFS_FC</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>Name of the datastore</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfHost</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHosts -status "Mystatus" -domainId "MydomainId" -clusterId "MyclusterId" -networkpoolId "MynetworkpoolId" -storageType "MystorageType" -datastoreName "MydatastoreName" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHosts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHosts </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHosts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHostsPrechecksResponse</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHostsPrechecksResponse</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get host(s) prechecks response</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHostsPrechecksResponse</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Execution ID returned by post hostsprecheks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Execution ID returned by post hostsprecheks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HostsPrechecksResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostsPrechecksResponse -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostsPrechecksResponse with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHostsPrechecksResponse -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHostsPrechecksResponse with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/prechecks/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTagsAssignedToHost</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTagsAssignedToHost</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Tags assigned to Host</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTagsAssignedToHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTag</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToHost -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToHost with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToHost -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToHost with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/id/tags/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTagsAssignedToHosts</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTagsAssignedToHosts</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Tags assigned to Hosts</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTagsAssignedToHosts</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTagsForResource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToHosts </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToHosts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTagsAssignedToHosts </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTagsAssignedToHosts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/tags/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfPostHostsPrechecks1</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfPostHostsPrechecks1</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Post host(s) prechecks</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfPostHostsPrechecks1</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SpecFile</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SpecFile</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HostsPrechecksResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfPostHostsPrechecks1 -specFile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostHostsPrechecks1 with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfPostHostsPrechecks1 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostHostsPrechecks1 with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/prechecks/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfPostQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfPostQuery</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Post a query</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfPostQuery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCriterion</maml:name> <maml:Description> <maml:para>Post a query request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HostCriterion</command:parameterValue> <dev:type> <maml:name>HostCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCriterion</maml:name> <maml:Description> <maml:para>Post a query request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HostCriterion</command:parameterValue> <dev:type> <maml:name>HostCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HostQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HostCriterion = Initialize-VcfHostCriterion -Name "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR, UNMANAGED_HOSTS_IN_HCIMGR_MANUAL_DISCOVERY" -SubCriteria $HostCriterion -Arguments @{ key_example = "MyInner" } -Description "MyDescription" Invoke-VcfPostQuery -hostCriterion $hostCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostQuery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostCriterion = Initialize-VcfHostCriterion Invoke-VcfPostQuery -hostCriterion $hostCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPostQuery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/queries/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHostCriterion</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRemoveTagsFromHost</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRemoveTagsFromHost</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove Tags From Host</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRemoveTagsFromHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>Remove Tags From Host request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Host ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagsSpec</maml:name> <maml:Description> <maml:para>Remove Tags From Host request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TagsSpec</command:parameterValue> <dev:type> <maml:name>TagsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TagAssignmentResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfRemoveTagsFromHost -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveTagsFromHost with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" Invoke-VcfRemoveTagsFromHost -id "Myid" -tagsSpec $tagsSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveTagsFromHost with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/id/tags/delete/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfTagsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateCommissionHosts</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateCommissionHosts</command:noun> <maml:description> <maml:para>Validate the input specification to commission the Hosts</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateCommissionHosts</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCommissionSpec</maml:name> <maml:Description> <maml:para>Validate the input specification to commission the Hosts request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostCommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCommissionSpec</maml:name> <maml:Description> <maml:para>Validate the input specification to commission the Hosts request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostCommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HostCommissionSpec = Initialize-VcfHostCommissionSpec -Fqdn "MyFqdn" -Username "MyUsername" -Password "MyPassword" -StorageType "One among: VSAN, VSAN_ESA, VSAN_REMOTE, VSAN_MAX, NFS, VMFS_FC, VVOL" -VvolStorageProtocolType "One among: ISCSI, NFS, FC" -NetworkPoolId "MyNetworkPoolId" -NetworkPoolName "MyNetworkPoolName" -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" Invoke-VcfValidateCommissionHosts -hostCommissionSpec $hostCommissionSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateCommissionHosts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostCommissionSpec = Initialize-VcfHostCommissionSpec -Fqdn "MyFqdn" -Username "MyUsername" -Password "MyPassword" -StorageType "One among: VSAN, VSAN_ESA, VSAN_REMOTE, VSAN_MAX, NFS, VMFS_FC, VVOL" -NetworkPoolId "MyNetworkPoolId" Invoke-VcfValidateCommissionHosts -hostCommissionSpec $hostCommissionSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateCommissionHosts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/validations/commissions/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateHostCommissionSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateHostCommissionSpec</command:noun> <maml:description> <maml:para>Perform validation of the HostCommissionSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateHostCommissionSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCommissionSpec</maml:name> <maml:Description> <maml:para>Perform validation of the HostCommissionSpec specification request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostCommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostCommissionSpec</maml:name> <maml:Description> <maml:para>Perform validation of the HostCommissionSpec specification request body.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostCommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HostCommissionSpec = Initialize-VcfHostCommissionSpec -Fqdn "MyFqdn" -Username "MyUsername" -Password "MyPassword" -StorageType "One among: VSAN, VSAN_ESA, VSAN_REMOTE, VSAN_MAX, NFS, VMFS_FC, VVOL" -VvolStorageProtocolType "One among: ISCSI, NFS, FC" -NetworkPoolId "MyNetworkPoolId" -NetworkPoolName "MyNetworkPoolName" -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" Invoke-VcfValidateHostCommissionSpec -hostCommissionSpec $hostCommissionSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateHostCommissionSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HostCommissionSpec = Initialize-VcfHostCommissionSpec -Fqdn "MyFqdn" -Username "MyUsername" -Password "MyPassword" -StorageType "One among: VSAN, VSAN_ESA, VSAN_REMOTE, VSAN_MAX, NFS, VMFS_FC, VVOL" -NetworkPoolId "MyNetworkPoolId" Invoke-VcfValidateHostCommissionSpec -hostCommissionSpec $hostCommissionSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateHostCommissionSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/hosts/validations/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHostSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>HostSpec</command:noun> <maml:description> <maml:para>This specification contains information required to add vSphere host to a cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains information required to add vSphere host to a cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHostSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of a vSphere host in the free pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>License key of a vSphere host in the free pool (This is required except in cases where the ESXi host has already been licensed outside of the VMware Cloud Foundation system)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP address of the vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostName</maml:name> <maml:Description> <maml:para>Host name of the vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username of the vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>SSH password of the vSphere host </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostNetworkSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HostNetworkSpec</command:parameterValue> <dev:type> <maml:name>HostNetworkSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AzName</maml:name> <maml:Description> <maml:para>Availability Zone Name (This is required while performing a stretched cluster expand operation)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshThumbprint</maml:name> <maml:Description> <maml:para>SSH thumbprint(fingerprint) of the vSphere host Note:This field will be mandatory in future releases.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SerialNumber</maml:name> <maml:Description> <maml:para>Serial Number of the vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of a vSphere host in the free pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>License key of a vSphere host in the free pool (This is required except in cases where the ESXi host has already been licensed outside of the VMware Cloud Foundation system)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP address of the vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostName</maml:name> <maml:Description> <maml:para>Host name of the vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username of the vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>SSH password of the vSphere host </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostNetworkSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HostNetworkSpec</command:parameterValue> <dev:type> <maml:name>HostNetworkSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AzName</maml:name> <maml:Description> <maml:para>Availability Zone Name (This is required while performing a stretched cluster expand operation)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshThumbprint</maml:name> <maml:Description> <maml:para>SSH thumbprint(fingerprint) of the vSphere host Note:This field will be mandatory in future releases.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SerialNumber</maml:name> <maml:Description> <maml:para>Serial Number of the vSphere host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" $HostNetworkSpec = Initialize-VcfHostNetworkSpec -VmNics $VmNic -NetworkProfileName "MyNetworkProfileName" $HostSpec = Initialize-VcfHostSpec -Id "MyId" -LicenseKey "MyLicenseKey" -IpAddress "MyIpAddress" -HostName "MyHostName" -Username "MyUsername" -Password "MyPassword" -HostNetworkSpec $HostNetworkSpec -AzName "MyAzName" -SshThumbprint "MySshThumbprint" -SerialNumber "MySerialNumber" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostSpec = Initialize-VcfHostSpec -Id "MyId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HostSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHostNetworkSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfHostsPrechecksRequest</command:name> <command:verb>Initialize</command:verb> <command:noun>HostsPrechecksRequest</command:noun> <maml:description> <maml:para>Represents hosts prechecks request</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents hosts prechecks request</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfHostsPrechecksRequest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Hosts</maml:name> <maml:Description> <maml:para>list of hosts on which prechecks will be done</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostCommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Hosts</maml:name> <maml:Description> <maml:para>list of hosts on which prechecks will be done</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HostCommissionSpec></command:parameterValue> <dev:type> <maml:name>List<HostCommissionSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $HostCommissionSpec = Initialize-VcfHostCommissionSpec -Fqdn "MyFqdn" -Username "MyUsername" -Password "MyPassword" -StorageType "One among: VSAN, VSAN_ESA, VSAN_REMOTE, VSAN_MAX, NFS, VMFS_FC, VVOL" -VvolStorageProtocolType "One among: ISCSI, NFS, FC" -NetworkPoolId "MyNetworkPoolId" -NetworkPoolName "MyNetworkPoolName" -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" $HostsPrechecksRequest = Initialize-VcfHostsPrechecksRequest -Hosts $HostCommissionSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostsPrechecksRequest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $HostsPrechecksRequest = Initialize-VcfHostsPrechecksRequest </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfHostsPrechecksRequest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/HostsPrechecksRequest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfIdentityProviderDirectory</command:name> <command:verb>Initialize</command:verb> <command:noun>IdentityProviderDirectory</command:noun> <maml:description> <maml:para>The directory configuration when the provider is via broker federation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The directory configuration when the provider is via broker federation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfIdentityProviderDirectory</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DirectoryId</maml:name> <maml:Description> <maml:para>The id of the directory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The user-friendly name for the directory. This must be unique and the allowed symbols are letters in any language, digits (0-9), space, underscore and hyphen</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultDomain</maml:name> <maml:Description> <maml:para>The trusted default domain of the directory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domains</maml:name> <maml:Description> <maml:para>The set of trusted domains of the directory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FederatedIdpSourceType</maml:name> <maml:Description> <maml:para>The type of the Federated IDP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DirectoryId</maml:name> <maml:Description> <maml:para>The id of the directory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The user-friendly name for the directory. This must be unique and the allowed symbols are letters in any language, digits (0-9), space, underscore and hyphen</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultDomain</maml:name> <maml:Description> <maml:para>The trusted default domain of the directory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domains</maml:name> <maml:Description> <maml:para>The set of trusted domains of the directory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FederatedIdpSourceType</maml:name> <maml:Description> <maml:para>The type of the Federated IDP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$IdentityProviderDirectory = Initialize-VcfIdentityProviderDirectory -DirectoryId "MyDirectoryId" -Name "MyName" -DefaultDomain "MyDefaultDomain" -Domains "MyDomains" -FederatedIdpSourceType "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIdentityProviderDirectory with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IdentityProviderDirectory = Initialize-VcfIdentityProviderDirectory -Name "MyName" -DefaultDomain "MyDefaultDomain" -Domains "MyDomains" -FederatedIdpSourceType "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIdentityProviderDirectory with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/IdentityProviderDirectory</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetIdentityPrecheckResult</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetIdentityPrecheckResult</command:noun> <maml:description> <maml:para>Get Identity Provider Federation Precheck Result</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list precheck result with warnings/errors</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetIdentityPrecheckResult</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>IDP type for which Precheck needs to be run</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>IDP type for which Precheck needs to be run</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IdentityProviderPrecheckResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetIdentityPrecheckResult -type "Mytype" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetIdentityPrecheckResult with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetIdentityPrecheckResult </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetIdentityPrecheckResult with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-broker/prechecks/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddEmbeddedIdentitySource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddEmbeddedIdentitySource</command:noun> <maml:description> <maml:para>Add a new identity source to the embedded identity provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add an identity source to an embedded IDP by id, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddEmbeddedIdentitySource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentitySourceSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentitySourceSpec</command:parameterValue> <dev:type> <maml:name>IdentitySourceSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentitySourceSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentitySourceSpec</command:parameterValue> <dev:type> <maml:name>IdentitySourceSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -CertChain "MyCertChain" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -DomainAlias "MyDomainAlias" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails $IdentitySourceSpec = Initialize-VcfIdentitySourceSpec -Name "MyName" -Ldap $LdapSpec Invoke-VcfAddEmbeddedIdentitySource -id "Myid" -identitySourceSpec $identitySourceSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddEmbeddedIdentitySource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails $IdentitySourceSpec = Initialize-VcfIdentitySourceSpec -Name "MyName" -Ldap $LdapSpec Invoke-VcfAddEmbeddedIdentitySource -id "Myid" -identitySourceSpec $identitySourceSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddEmbeddedIdentitySource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-providers/id/identity-sources/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIdentitySourceSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddExternalIdentityProvider</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddExternalIdentityProvider</command:noun> <maml:description> <maml:para>Add a new external identity provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add a new external identity provider</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddExternalIdentityProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentityProviderSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentityProviderSpec</command:parameterValue> <dev:type> <maml:name>IdentityProviderSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentityProviderSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentityProviderSpec</command:parameterValue> <dev:type> <maml:name>IdentityProviderSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -CertChain "MyCertChain" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -DomainAlias "MyDomainAlias" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails $OidcSpec = Initialize-VcfOidcSpec -ClientId "MyClientId" -ClientSecret "MyClientSecret" -DiscoveryEndpoint "MyDiscoveryEndpoint" $IdentityProviderDirectory = Initialize-VcfIdentityProviderDirectory -DirectoryId "MyDirectoryId" -Name "MyName" -DefaultDomain "MyDefaultDomain" -Domains "MyDomains" -FederatedIdpSourceType "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE" $FederatedIdentityProviderSpec = Initialize-VcfFederatedIdentityProviderSpec -Name "MyName" -Directory $IdentityProviderDirectory -OidcSpec $OidcSpec -SyncClientTokenTTL 0 $IdentityProviderSpec = Initialize-VcfIdentityProviderSpec -Name "MyName" -Type "MyType" -CertChain "MyCertChain" -Ldap $LdapSpec -Oidc $OidcSpec -FedIdpSpec $FederatedIdentityProviderSpec Invoke-VcfAddExternalIdentityProvider -identityProviderSpec $identityProviderSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddExternalIdentityProvider with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IdentityProviderSpec = Initialize-VcfIdentityProviderSpec -Name "MyName" -Type "MyType" Invoke-VcfAddExternalIdentityProvider -identityProviderSpec $identityProviderSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddExternalIdentityProvider with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-providers/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIdentityProviderSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteExternalIdentityProvider</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteExternalIdentityProvider</command:noun> <maml:description> <maml:para>Remove an identity provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete an Identity Provider by its identifier, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteExternalIdentityProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteExternalIdentityProvider -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteExternalIdentityProvider with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteExternalIdentityProvider -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteExternalIdentityProvider with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-providers/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteIdentitySource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteIdentitySource</command:noun> <maml:description> <maml:para>Delete an Identity Source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete an Identity Source by domain name, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteIdentitySource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Domain Name associated with the identity source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Domain Name associated with the identity source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteIdentitySource -id "Myid" -domainName "MydomainName" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteIdentitySource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteIdentitySource -id "Myid" -domainName "MydomainName" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteIdentitySource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-providers/id/identity-sources/domainname/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGenerateSyncClientToken</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGenerateSyncClientToken</command:noun> <maml:description> <maml:para>Generate new sync client token</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates a new sync client token</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGenerateSyncClientToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SyncClientTokenTTL</maml:name> <maml:Description> <maml:para>TTL of the sync client token</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SyncClientTokenTTL</maml:name> <maml:Description> <maml:para>TTL of the sync client token</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGenerateSyncClientToken -id "Myid" -syncClientTokenTTL 789 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGenerateSyncClientToken with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGenerateSyncClientToken -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGenerateSyncClientToken with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-providers/id/sync-client/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetIdentityProviderById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetIdentityProviderById</command:noun> <maml:description> <maml:para>Get an identity provider by its id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a specific identity irovider using its id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetIdentityProviderById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IdentityProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetIdentityProviderById -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetIdentityProviderById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetIdentityProviderById -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetIdentityProviderById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-providers/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetIdentityProviders</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetIdentityProviders</command:noun> <maml:description> <maml:para>Get all identity providers</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all identity providers</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetIdentityProviders</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfIdentityProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetIdentityProviders </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetIdentityProviders with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetIdentityProviders </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetIdentityProviders with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-providers/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSddcWs1bOidcInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSddcWs1bOidcInfo</command:noun> <maml:description> <maml:para>Get the SDDC Manager WS1B OIDC Information</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the SDDC Manager WS1B OIDC Information</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSddcWs1bOidcInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SDDCManagerOidcInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcWs1bOidcInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcWs1bOidcInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcWs1bOidcInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcWs1bOidcInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-broker/sddc-manager-oidc/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateEmbeddedIdentitySource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateEmbeddedIdentitySource</command:noun> <maml:description> <maml:para>Update an identity source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the identity source associated with the embedded IDP by name, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateEmbeddedIdentitySource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Domain Name associated with the identity source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentitySourceSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentitySourceSpec</command:parameterValue> <dev:type> <maml:name>IdentitySourceSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Domain Name associated with the identity source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentitySourceSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentitySourceSpec</command:parameterValue> <dev:type> <maml:name>IdentitySourceSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -CertChain "MyCertChain" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -DomainAlias "MyDomainAlias" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails $IdentitySourceSpec = Initialize-VcfIdentitySourceSpec -Name "MyName" -Ldap $LdapSpec Invoke-VcfUpdateEmbeddedIdentitySource -id "Myid" -domainName "MydomainName" -identitySourceSpec $identitySourceSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateEmbeddedIdentitySource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails $IdentitySourceSpec = Initialize-VcfIdentitySourceSpec -Name "MyName" -Ldap $LdapSpec Invoke-VcfUpdateEmbeddedIdentitySource -id "Myid" -domainName "MydomainName" -identitySourceSpec $identitySourceSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateEmbeddedIdentitySource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-providers/id/identity-sources/domainname/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIdentitySourceSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateExternalIdentityProvider</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateExternalIdentityProvider</command:noun> <maml:description> <maml:para>Update an identity provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the identity provider by its identifier, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateExternalIdentityProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentityProviderSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentityProviderSpec</command:parameterValue> <dev:type> <maml:name>IdentityProviderSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentityProviderSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IdentityProviderSpec</command:parameterValue> <dev:type> <maml:name>IdentityProviderSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -CertChain "MyCertChain" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -DomainAlias "MyDomainAlias" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails $OidcSpec = Initialize-VcfOidcSpec -ClientId "MyClientId" -ClientSecret "MyClientSecret" -DiscoveryEndpoint "MyDiscoveryEndpoint" $IdentityProviderDirectory = Initialize-VcfIdentityProviderDirectory -DirectoryId "MyDirectoryId" -Name "MyName" -DefaultDomain "MyDefaultDomain" -Domains "MyDomains" -FederatedIdpSourceType "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE" $FederatedIdentityProviderSpec = Initialize-VcfFederatedIdentityProviderSpec -Name "MyName" -Directory $IdentityProviderDirectory -OidcSpec $OidcSpec -SyncClientTokenTTL 0 $IdentityProviderSpec = Initialize-VcfIdentityProviderSpec -Name "MyName" -Type "MyType" -CertChain "MyCertChain" -Ldap $LdapSpec -Oidc $OidcSpec -FedIdpSpec $FederatedIdentityProviderSpec Invoke-VcfUpdateExternalIdentityProvider -id "Myid" -identityProviderSpec $identityProviderSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateExternalIdentityProvider with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IdentityProviderSpec = Initialize-VcfIdentityProviderSpec -Name "MyName" -Type "MyType" Invoke-VcfUpdateExternalIdentityProvider -id "Myid" -identityProviderSpec $identityProviderSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateExternalIdentityProvider with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/identity-providers/id/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIdentityProviderSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfIdentityProviderSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>IdentityProviderSpec</command:noun> <maml:description> <maml:para>Identity Provider Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Identity Provider Spec</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfIdentityProviderSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The user-friendly name for the Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of Identity Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertChain</maml:name> <maml:Description> <maml:para>The root certificate chain required to connect to the external server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Ldap</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LdapSpec</command:parameterValue> <dev:type> <maml:name>LdapSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Oidc</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OidcSpec</command:parameterValue> <dev:type> <maml:name>OidcSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FedIdpSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FederatedIdentityProviderSpec</command:parameterValue> <dev:type> <maml:name>FederatedIdentityProviderSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The user-friendly name for the Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of Identity Identity Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertChain</maml:name> <maml:Description> <maml:para>The root certificate chain required to connect to the external server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Ldap</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LdapSpec</command:parameterValue> <dev:type> <maml:name>LdapSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Oidc</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OidcSpec</command:parameterValue> <dev:type> <maml:name>OidcSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FedIdpSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FederatedIdentityProviderSpec</command:parameterValue> <dev:type> <maml:name>FederatedIdentityProviderSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -CertChain "MyCertChain" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -DomainAlias "MyDomainAlias" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails $OidcSpec = Initialize-VcfOidcSpec -ClientId "MyClientId" -ClientSecret "MyClientSecret" -DiscoveryEndpoint "MyDiscoveryEndpoint" $IdentityProviderDirectory = Initialize-VcfIdentityProviderDirectory -DirectoryId "MyDirectoryId" -Name "MyName" -DefaultDomain "MyDefaultDomain" -Domains "MyDomains" -FederatedIdpSourceType "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE" $FederatedIdentityProviderSpec = Initialize-VcfFederatedIdentityProviderSpec -Name "MyName" -Directory $IdentityProviderDirectory -OidcSpec $OidcSpec -SyncClientTokenTTL 0 $IdentityProviderSpec = Initialize-VcfIdentityProviderSpec -Name "MyName" -Type "MyType" -CertChain "MyCertChain" -Ldap $LdapSpec -Oidc $OidcSpec -FedIdpSpec $FederatedIdentityProviderSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIdentityProviderSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $IdentityProviderSpec = Initialize-VcfIdentityProviderSpec -Name "MyName" -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIdentityProviderSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/IdentityProviderSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLdapSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOidcSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfFederatedIdentityProviderSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfIdentitySourceSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>IdentitySourceSpec</command:noun> <maml:description> <maml:para>Identity Source Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Identity Source Spec</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfIdentitySourceSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The user-friendly name for the identity Source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Ldap</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LdapSpec</command:parameterValue> <dev:type> <maml:name>LdapSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The user-friendly name for the identity Source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Ldap</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LdapSpec</command:parameterValue> <dev:type> <maml:name>LdapSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -CertChain "MyCertChain" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -DomainAlias "MyDomainAlias" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails $IdentitySourceSpec = Initialize-VcfIdentitySourceSpec -Name "MyName" -Ldap $LdapSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIdentitySourceSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails $IdentitySourceSpec = Initialize-VcfIdentitySourceSpec -Name "MyName" -Ldap $LdapSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIdentitySourceSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/IdentitySourceSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLdapSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfImportVdsSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ImportVdsSpec</command:noun> <maml:description> <maml:para>Import Vds Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import Vds Spec</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfImportVdsSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ListOfVdsDetails</maml:name> <maml:Description> <maml:para>List of details of vSphere Distributed Switches to be imported to the inventory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VdsDetail></command:parameterValue> <dev:type> <maml:name>List<VdsDetail></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ListOfVdsDetails</maml:name> <maml:Description> <maml:para>List of details of vSphere Distributed Switches to be imported to the inventory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VdsDetail></command:parameterValue> <dev:type> <maml:name>List<VdsDetail></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VdsDetail = Initialize-VcfVdsDetail -VdsName "MyVdsName" $ImportVdsSpec = Initialize-VcfImportVdsSpec -ListOfVdsDetails $VdsDetail </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfImportVdsSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VdsDetail = Initialize-VcfVdsDetail -VdsName "MyVdsName" $ImportVdsSpec = Initialize-VcfImportVdsSpec -ListOfVdsDetails $VdsDetail </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfImportVdsSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ImportVdsSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-Vcfinline_object_4</command:name> <command:verb>Initialize</command:verb> <command:noun>inline_object_4</command:noun> <maml:description> <maml:para>No description available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-Vcfinline_object_4</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SpecFile</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SpecFile</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$InlineObject4 = Initialize-VcfInlineObject4 -SpecFile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-Vcfinline_object_4 with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$InlineObject4 = Initialize-VcfInlineObject4 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-Vcfinline_object_4 with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/InlineObject4</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfIpAddressPoolRangeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>IpAddressPoolRangeSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to create an IP address range</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to create an IP address range</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfIpAddressPoolRangeSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Start</maml:name> <maml:Description> <maml:para>The first IP Address of the IP Address Range</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>End</maml:name> <maml:Description> <maml:para>The last IP Address of the IP Address Range</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Start</maml:name> <maml:Description> <maml:para>The first IP Address of the IP Address Range</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>End</maml:name> <maml:Description> <maml:para>The last IP Address of the IP Address Range</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIpAddressPoolRangeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIpAddressPoolRangeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/IpAddressPoolRangeSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfIpAddressPoolSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>IpAddressPoolSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to create or reuse an IP address pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to create or reuse an IP address pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfIpAddressPoolSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the IP address pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the IP address pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IgnoreUnavailableNsxtCluster</maml:name> <maml:Description> <maml:para>Ignore unavailable NSX cluster(s) during IP pool spec validation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Subnets</maml:name> <maml:Description> <maml:para>List of IP address pool subnet specification</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSubnetSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSubnetSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the IP address pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the IP address pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IgnoreUnavailableNsxtCluster</maml:name> <maml:Description> <maml:para>Ignore unavailable NSX cluster(s) during IP pool spec validation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Subnets</maml:name> <maml:Description> <maml:para>List of IP address pool subnet specification</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSubnetSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSubnetSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIpAddressPoolSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIpAddressPoolSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/IpAddressPoolSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfIpAddressPoolSubnetSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>IpAddressPoolSubnetSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to create an IP address pool subnet</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to create an IP address pool subnet</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfIpAddressPoolSubnetSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolRanges</maml:name> <maml:Description> <maml:para>List of the IP allocation ranges. Atleast 1 IP address range has to be specified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolRangeSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolRangeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Cidr</maml:name> <maml:Description> <maml:para>The subnet representation, contains the network address and the prefix length</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>The default gateway address of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolRanges</maml:name> <maml:Description> <maml:para>List of the IP allocation ranges. Atleast 1 IP address range has to be specified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolRangeSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolRangeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Cidr</maml:name> <maml:Description> <maml:para>The subnet representation, contains the network address and the prefix length</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>The default gateway address of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIpAddressPoolSubnetSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIpAddressPoolSubnetSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/IpAddressPoolSubnetSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfIpPool</command:name> <command:verb>Initialize</command:verb> <command:noun>IpPool</command:noun> <maml:description> <maml:para>Represents an IP Pool of a network in a network pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents an IP Pool of a network in a network pool</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfIpPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Start IP address of the IP pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>End</maml:name> <maml:Description> <maml:para>End IP address of the IP pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Start</maml:name> <maml:Description> <maml:para>Start IP address of the IP pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>End</maml:name> <maml:Description> <maml:para>End IP address of the IP pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIpPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIpPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/IpPool</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfIsolationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>IsolationSpec</command:noun> <maml:description> <maml:para>Domain Isolation Details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Domain Isolation Details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfIsolationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomainSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SsoDomainSpec</command:parameterValue> <dev:type> <maml:name>SsoDomainSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIdForIsolation</maml:name> <maml:Description> <maml:para>Id of the domain that needs to be isolated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WorkloadDomainName</maml:name> <maml:Description> <maml:para>Name of the domain that needs to be isolated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomainSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SsoDomainSpec</command:parameterValue> <dev:type> <maml:name>SsoDomainSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIdForIsolation</maml:name> <maml:Description> <maml:para>Id of the domain that needs to be isolated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WorkloadDomainName</maml:name> <maml:Description> <maml:para>Name of the domain that needs to be isolated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $SsoDomainSpec = Initialize-VcfSsoDomainSpec -SsoDomainPassword "MySsoDomainPassword" -SsoDomainName "MySsoDomainName" $IsolationSpec = Initialize-VcfIsolationSpec -SsoDomainSpec $SsoDomainSpec -DomainIdForIsolation "MyDomainIdForIsolation" -WorkloadDomainName "MyWorkloadDomainName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIsolationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $IsolationSpec = Initialize-VcfIsolationSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfIsolationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/IsolationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSsoDomainSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLdapSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>LdapSpec</command:noun> <maml:description> <maml:para>The LDAP specification when the protocol is LDAP</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The LDAP specification when the protocol is LDAP</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLdapSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the LDAP Server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>The name to associate with the created domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainAlias</maml:name> <maml:Description> <maml:para>The optional alias to associate the domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>User name to connect to ldap(s) server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password to connect to the ldap(s) server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceDetails</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SourceDetails</command:parameterValue> <dev:type> <maml:name>SourceDetails</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the LDAP Server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>The name to associate with the created domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainAlias</maml:name> <maml:Description> <maml:para>The optional alias to associate the domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>User name to connect to ldap(s) server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password to connect to the ldap(s) server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceDetails</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SourceDetails</command:parameterValue> <dev:type> <maml:name>SourceDetails</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -CertChain "MyCertChain" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -DomainAlias "MyDomainAlias" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLdapSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -ServerEndpoints "MyServerEndpoints" $LdapSpec = Initialize-VcfLdapSpec -Type "One among: OpenLdap, ActiveDirectory" -DomainName "MyDomainName" -Username "MyUsername" -Password "MyPassword" -SourceDetails $SourceDetails </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLdapSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/LdapSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSourceDetails</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLicenseCheckResource</command:name> <command:verb>Initialize</command:verb> <command:noun>LicenseCheckResource</command:noun> <maml:description> <maml:para>License check resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>License check resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLicenseCheckResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceInfo</command:parameterValue> <dev:type> <maml:name>ResourceInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProductInfo</command:parameterValue> <dev:type> <maml:name>ProductInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceInfo</command:parameterValue> <dev:type> <maml:name>ResourceInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProductInfo</command:parameterValue> <dev:type> <maml:name>ProductInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" -ClusterId "a0bf0f65-f719-4c2d-980a-29a9094045b5" -HostId "b0bf0f65-f719-4c2d-980a-29a9094045b5" $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $ProductInfo = Initialize-VcfProductInfo -LicenseKey "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" -Type "One among: VCENTER, NSXT, VSAN, WCP, ESXI" -LicensingMode "One among: SUBSCRIPTION, PERPETUAL, MIXED" -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -LicenseKeyExpirationDate "2021-04-08T04:37:51.662Z" -ErrorResponse $Error $LicenseCheckResource = Initialize-VcfLicenseCheckResource -ResourceInfo $ResourceInfo -ProductInfo $ProductInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseCheckResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" $LicenseCheckResource = Initialize-VcfLicenseCheckResource -ResourceInfo $ResourceInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseCheckResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/LicenseCheckResource</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfResourceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfProductInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLicenseKey</command:name> <command:verb>Initialize</command:verb> <command:noun>LicenseKey</command:noun> <maml:description> <maml:para>Defines a license key and its attributes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Defines a license key and its attributes</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLicenseKey</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The 29 alpha numeric character license key with hyphens</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>The type of the product to which the license key is applicable</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the license key given by user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersion</maml:name> <maml:Description> <maml:para>Product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsUnlimited</maml:name> <maml:Description> <maml:para>Indicates if the license key has unlimited usage</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyUsage</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicenseKeyUsage</command:parameterValue> <dev:type> <maml:name>LicenseKeyUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyValidity</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicenseKeyValidity</command:parameterValue> <dev:type> <maml:name>LicenseKeyValidity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Features</maml:name> <maml:Description> <maml:para>License key features</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseEdition</maml:name> <maml:Description> <maml:para>License key edition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseUnit</maml:name> <maml:Description> <maml:para>License capacity unit</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MinimumCore</maml:name> <maml:Description> <maml:para>The minimum number of core licenses required per CPU, when license unit is cpu core</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The 29 alpha numeric character license key with hyphens</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>The type of the product to which the license key is applicable</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the license key given by user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersion</maml:name> <maml:Description> <maml:para>Product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsUnlimited</maml:name> <maml:Description> <maml:para>Indicates if the license key has unlimited usage</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyUsage</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicenseKeyUsage</command:parameterValue> <dev:type> <maml:name>LicenseKeyUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyValidity</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicenseKeyValidity</command:parameterValue> <dev:type> <maml:name>LicenseKeyValidity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Features</maml:name> <maml:Description> <maml:para>License key features</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseEdition</maml:name> <maml:Description> <maml:para>License key edition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseUnit</maml:name> <maml:Description> <maml:para>License capacity unit</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MinimumCore</maml:name> <maml:Description> <maml:para>The minimum number of core licenses required per CPU, when license unit is cpu core</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $LicenseKeyUsage = Initialize-VcfLicenseKeyUsage -Total 0 -Remaining 0 -Used 0 -LicenseUnit "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER, CPUCORE, TIB" $LicenseKeyValidity = Initialize-VcfLicenseKeyValidity -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -ExpiryDate "MyExpiryDate" $LicenseKey = Initialize-VcfLicenseKey -Id "MyId" -Key "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX " -ProductType "One among: VCENTER, VSAN, ESXI, NSXT, WCP" -Description "MyDescription" -ProductVersion "MyProductVersion" -IsUnlimited $false -LicenseKeyUsage $LicenseKeyUsage -LicenseKeyValidity $LicenseKeyValidity -Features "MyFeatures" -LicenseEdition "MyLicenseEdition" -LicenseUnit "MyLicenseUnit" -MinimumCore 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseKey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $LicenseKey = Initialize-VcfLicenseKey -Key "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX " -ProductType "One among: VCENTER, VSAN, ESXI, NSXT, WCP" -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseKey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/LicenseKey</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLicenseKeyUsage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLicenseKeyValidity</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddLicenseKey</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddLicenseKey</command:noun> <maml:description> <maml:para>Add a a new license key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddLicenseKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicenseKey</command:parameterValue> <dev:type> <maml:name>LicenseKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicenseKey</command:parameterValue> <dev:type> <maml:name>LicenseKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LicenseKeyUsage = Initialize-VcfLicenseKeyUsage -Total 0 -Remaining 0 -Used 0 -LicenseUnit "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER, CPUCORE, TIB" $LicenseKeyValidity = Initialize-VcfLicenseKeyValidity -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -ExpiryDate "MyExpiryDate" $LicenseKey = Initialize-VcfLicenseKey -Id "MyId" -Key "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX " -ProductType "One among: VCENTER, VSAN, ESXI, NSXT, WCP" -Description "MyDescription" -ProductVersion "MyProductVersion" -IsUnlimited $false -LicenseKeyUsage $LicenseKeyUsage -LicenseKeyValidity $LicenseKeyValidity -Features "MyFeatures" -LicenseEdition "MyLicenseEdition" -LicenseUnit "MyLicenseUnit" -MinimumCore 0 Invoke-VcfAddLicenseKey -licenseKey $licenseKey </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddLicenseKey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LicenseKey = Initialize-VcfLicenseKey -Key "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX " -ProductType "One among: VCENTER, VSAN, ESXI, NSXT, WCP" -Description "MyDescription" Invoke-VcfAddLicenseKey -licenseKey $licenseKey </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddLicenseKey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/license-keys/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLicenseKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDomainLicensingInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDomainLicensingInfo</command:noun> <maml:description> <maml:para>Get the Licensing information of a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDomainLicensingInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>LicensingInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainLicensingInfo -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainLicensingInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainLicensingInfo -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainLicensingInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/licensing-info/domains/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetLicenseCheckResultByID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetLicenseCheckResultByID</command:noun> <maml:description> <maml:para>Retrieve the results of a license check by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetLicenseCheckResultByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The resources license check ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The resources license check ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ResourcesLicenseCheckResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseCheckResultByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseCheckResultByID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseCheckResultByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseCheckResultByID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resources/license-checks/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetLicenseInformation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetLicenseInformation</command:noun> <maml:description> <maml:para>Retrieve licensing information</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetLicenseInformation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Resource IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Resource IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<LicensingInfo></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseInformation -resourceType SYSTEM,DOMAIN -resourceIds "MyresourceIds" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseInformation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseInformation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseInformation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/licensing-info/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetLicenseKey</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetLicenseKey</command:noun> <maml:description> <maml:para>Retrieve a license key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetLicenseKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The 29 alpha numeric character license key with hyphens</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The 29 alpha numeric character license key with hyphens</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>LicenseKey</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseKey -key 4J6TH-3XK57-480X4-0E9H6-2X00P </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseKey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseKey -key 4J6TH-3XK57-480X4-0E9H6-2X00P </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseKey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/license-keys/key/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetLicenseKeys</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetLicenseKeys</command:noun> <maml:description> <maml:para>Retrieve a list of license keys</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetLicenseKeys</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>Type of a Product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyStatus</maml:name> <maml:Description> <maml:para>Status of a License Key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseUnit</maml:name> <maml:Description> <maml:para>Unit of a license</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersion</maml:name> <maml:Description> <maml:para>Product Version, gets the license keys matching the major version of the product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>Type of a Product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyStatus</maml:name> <maml:Description> <maml:para>Status of a License Key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseUnit</maml:name> <maml:Description> <maml:para>Unit of a license</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersion</maml:name> <maml:Description> <maml:para>Product Version, gets the license keys matching the major version of the product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfLicenseKey</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseKeys -productType "MyproductType" -licenseKeyStatus "MylicenseKeyStatus" -licenseUnit "MylicenseUnit" -productVersion 6,7.0.3,8.0 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseKeys with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseKeys </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseKeys with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/license-keys/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetLicenseProductTypes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetLicenseProductTypes</command:noun> <maml:description> <maml:para>Get product types</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetLicenseProductTypes</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<string></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseProductTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseProductTypes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetLicenseProductTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLicenseProductTypes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/license-keys/product-types/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSystemLicensingInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSystemLicensingInfo</command:noun> <maml:description> <maml:para>Get the Licensing information of system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSystemLicensingInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>LicensingInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSystemLicensingInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSystemLicensingInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSystemLicensingInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSystemLicensingInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/licensing-info/system/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRemoveLicenseKey</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRemoveLicenseKey</command:noun> <maml:description> <maml:para>Remove a license key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRemoveLicenseKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The 29 alpha numeric character license key with hyphens</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The 29 alpha numeric character license key with hyphens</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveLicenseKey -key 4J6TH-3XK57-480X4-0E9H6-2X00P </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveLicenseKey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveLicenseKey -key 4J6TH-3XK57-480X4-0E9H6-2X00P </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveLicenseKey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/license-keys/key/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfSetLicenseKeyForResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfSetLicenseKeyForResource</command:noun> <maml:description> <maml:para>Update a license key for a resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfSetLicenseKeyForResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicensingSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicensingSpec</command:parameterValue> <dev:type> <maml:name>LicensingSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicensingSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicensingSpec</command:parameterValue> <dev:type> <maml:name>LicensingSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" -ClusterId "a0bf0f65-f719-4c2d-980a-29a9094045b5" -HostId "b0bf0f65-f719-4c2d-980a-29a9094045b5" $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $ProductInfo = Initialize-VcfProductInfo -LicenseKey "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" -Type "One among: VCENTER, NSXT, VSAN, WCP, ESXI" -LicensingMode "One among: SUBSCRIPTION, PERPETUAL, MIXED" -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -LicenseKeyExpirationDate "2021-04-08T04:37:51.662Z" -ErrorResponse $Error $ResourceLicensingInfo = Initialize-VcfResourceLicensingInfo -ResourceInfo $ResourceInfo -ProductInfo $ProductInfo $LicensingSpec = Initialize-VcfLicensingSpec -ResourceLicensingInfos $ResourceLicensingInfo Invoke-VcfSetLicenseKeyForResource -licensingSpec $licensingSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfSetLicenseKeyForResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" $ResourceLicensingInfo = Initialize-VcfResourceLicensingInfo -ResourceInfo $ResourceInfo $LicensingSpec = Initialize-VcfLicensingSpec -ResourceLicensingInfos $ResourceLicensingInfo Invoke-VcfSetLicenseKeyForResource -licensingSpec $licensingSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfSetLicenseKeyForResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resources/licensing-infos/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLicensingSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartLicenseCheckByResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartLicenseCheckByResource</command:noun> <maml:description> <maml:para>Start a license check for a resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartLicenseCheckByResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourcesLicenseCheckSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourcesLicenseCheckSpec</command:parameterValue> <dev:type> <maml:name>ResourcesLicenseCheckSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourcesLicenseCheckSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourcesLicenseCheckSpec</command:parameterValue> <dev:type> <maml:name>ResourcesLicenseCheckSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ResourcesLicenseCheckResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" -ClusterId "a0bf0f65-f719-4c2d-980a-29a9094045b5" -HostId "b0bf0f65-f719-4c2d-980a-29a9094045b5" $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $ProductInfo = Initialize-VcfProductInfo -LicenseKey "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" -Type "One among: VCENTER, NSXT, VSAN, WCP, ESXI" -LicensingMode "One among: SUBSCRIPTION, PERPETUAL, MIXED" -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -LicenseKeyExpirationDate "2021-04-08T04:37:51.662Z" -ErrorResponse $Error $LicenseCheckResource = Initialize-VcfLicenseCheckResource -ResourceInfo $ResourceInfo -ProductInfo $ProductInfo $ResourcesLicenseCheckSpec = Initialize-VcfResourcesLicenseCheckSpec -LicenseCheckResources $LicenseCheckResource -ForAllDomains $false Invoke-VcfStartLicenseCheckByResource -resourcesLicenseCheckSpec $resourcesLicenseCheckSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartLicenseCheckByResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourcesLicenseCheckSpec = Initialize-VcfResourcesLicenseCheckSpec Invoke-VcfStartLicenseCheckByResource -resourcesLicenseCheckSpec $resourcesLicenseCheckSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartLicenseCheckByResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resources/license-checks/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfResourcesLicenseCheckSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateLicenseKey</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateLicenseKey</command:noun> <maml:description> <maml:para>Update the license key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateLicenseKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyOrId</maml:name> <maml:Description> <maml:para>license key or ID of the LicenseKey</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicenseKeyUpdateSpec</command:parameterValue> <dev:type> <maml:name>LicenseKeyUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyOrId</maml:name> <maml:Description> <maml:para>license key or ID of the LicenseKey</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LicenseKeyUpdateSpec</command:parameterValue> <dev:type> <maml:name>LicenseKeyUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LicenseKeyUpdateSpec = Initialize-VcfLicenseKeyUpdateSpec -Description "MyDescription" Invoke-VcfUpdateLicenseKey -licenseKeyOrId "MylicenseKeyOrId" -licenseKeyUpdateSpec $licenseKeyUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateLicenseKey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LicenseKeyUpdateSpec = Initialize-VcfLicenseKeyUpdateSpec -Description "MyDescription" Invoke-VcfUpdateLicenseKey -licenseKeyOrId "MylicenseKeyOrId" -licenseKeyUpdateSpec $licenseKeyUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateLicenseKey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/license-keys/licensekeyorid/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLicenseKeyUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLicenseKeyUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>LicenseKeyUpdateSpec</command:noun> <maml:description> <maml:para>Spec for updating a license key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec for updating a license key</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLicenseKeyUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>String for updating the description of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>String for updating the description of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LicenseKeyUpdateSpec = Initialize-VcfLicenseKeyUpdateSpec -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseKeyUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LicenseKeyUpdateSpec = Initialize-VcfLicenseKeyUpdateSpec -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseKeyUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/LicenseKeyUpdateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLicenseKeyUsage</command:name> <command:verb>Initialize</command:verb> <command:noun>LicenseKeyUsage</command:noun> <maml:description> <maml:para>Defines license key usage</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Defines license key usage</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLicenseKeyUsage</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Total</maml:name> <maml:Description> <maml:para>The total units of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Remaining</maml:name> <maml:Description> <maml:para>The remaining/free units of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Used</maml:name> <maml:Description> <maml:para>The consumed/used units of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseUnit</maml:name> <maml:Description> <maml:para>Units of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Total</maml:name> <maml:Description> <maml:para>The total units of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Remaining</maml:name> <maml:Description> <maml:para>The remaining/free units of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Used</maml:name> <maml:Description> <maml:para>The consumed/used units of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseUnit</maml:name> <maml:Description> <maml:para>Units of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LicenseKeyUsage = Initialize-VcfLicenseKeyUsage -Total 0 -Remaining 0 -Used 0 -LicenseUnit "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER, CPUCORE, TIB" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseKeyUsage with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LicenseKeyUsage = Initialize-VcfLicenseKeyUsage </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseKeyUsage with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/LicenseKeyUsage</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLicenseKeyValidity</command:name> <command:verb>Initialize</command:verb> <command:noun>LicenseKeyValidity</command:noun> <maml:description> <maml:para>Defines license key validity details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Defines license key validity details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLicenseKeyValidity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyStatus</maml:name> <maml:Description> <maml:para>The validity status of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExpiryDate</maml:name> <maml:Description> <maml:para>The license key expiry date</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyStatus</maml:name> <maml:Description> <maml:para>The validity status of the license key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExpiryDate</maml:name> <maml:Description> <maml:para>The license key expiry date</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LicenseKeyValidity = Initialize-VcfLicenseKeyValidity -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -ExpiryDate "MyExpiryDate" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseKeyValidity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LicenseKeyValidity = Initialize-VcfLicenseKeyValidity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicenseKeyValidity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/LicenseKeyValidity</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLicensingSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>LicensingSpec</command:noun> <maml:description> <maml:para>License Information of resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>License Information of resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLicensingSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceLicensingInfos</maml:name> <maml:Description> <maml:para>List of LicensingInfos of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceLicensingInfo></command:parameterValue> <dev:type> <maml:name>List<ResourceLicensingInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceLicensingInfos</maml:name> <maml:Description> <maml:para>List of LicensingInfos of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceLicensingInfo></command:parameterValue> <dev:type> <maml:name>List<ResourceLicensingInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" -ClusterId "a0bf0f65-f719-4c2d-980a-29a9094045b5" -HostId "b0bf0f65-f719-4c2d-980a-29a9094045b5" $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $ProductInfo = Initialize-VcfProductInfo -LicenseKey "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" -Type "One among: VCENTER, NSXT, VSAN, WCP, ESXI" -LicensingMode "One among: SUBSCRIPTION, PERPETUAL, MIXED" -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -LicenseKeyExpirationDate "2021-04-08T04:37:51.662Z" -ErrorResponse $Error $ResourceLicensingInfo = Initialize-VcfResourceLicensingInfo -ResourceInfo $ResourceInfo -ProductInfo $ProductInfo $LicensingSpec = Initialize-VcfLicensingSpec -ResourceLicensingInfos $ResourceLicensingInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicensingSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" $ResourceLicensingInfo = Initialize-VcfResourceLicensingInfo -ResourceInfo $ResourceInfo $LicensingSpec = Initialize-VcfLicensingSpec -ResourceLicensingInfos $ResourceLicensingInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLicensingSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/LicensingSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLocalAccountPasswordInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>LocalAccountPasswordInfo</command:noun> <maml:description> <maml:para>Local user password details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Local user password details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLocalAccountPasswordInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OldPassword</maml:name> <maml:Description> <maml:para>The old password of the local account</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NewPassword</maml:name> <maml:Description> <maml:para>The new password of the local account</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OldPassword</maml:name> <maml:Description> <maml:para>The old password of the local account</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NewPassword</maml:name> <maml:Description> <maml:para>The new password of the local account</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LocalAccountPasswordInfo = Initialize-VcfLocalAccountPasswordInfo -OldPassword "MyOldPassword" -NewPassword "MyNewPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLocalAccountPasswordInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LocalAccountPasswordInfo = Initialize-VcfLocalAccountPasswordInfo -NewPassword "MyNewPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLocalAccountPasswordInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/LocalAccountPasswordInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLocalizableWarningPack</command:name> <command:verb>Initialize</command:verb> <command:noun>LocalizableWarningPack</command:noun> <maml:description> <maml:para>Localization warning pack containing all required data to provide localized warning messages</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Localization warning pack containing all required data to provide localized warning messages</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLocalizableWarningPack</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WarningCode</maml:name> <maml:Description> <maml:para>Minor warning code</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalBundle</maml:name> <maml:Description> <maml:para>Local bundle to be used for localization</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VipComponent</maml:name> <maml:Description> <maml:para>VIP component that contains the message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultMessage</maml:name> <maml:Description> <maml:para>Default warning message in English. Will be used as fallback if a localized message cannot be obtained</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments used to localize the message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReferenceToken</maml:name> <maml:Description> <maml:para>A reference token correlating the warning with the relevant detailed logs. Should be sent to the service provider when reporting issues</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WarningCode</maml:name> <maml:Description> <maml:para>Minor warning code</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalBundle</maml:name> <maml:Description> <maml:para>Local bundle to be used for localization</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VipComponent</maml:name> <maml:Description> <maml:para>VIP component that contains the message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultMessage</maml:name> <maml:Description> <maml:para>Default warning message in English. Will be used as fallback if a localized message cannot be obtained</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments used to localize the message</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReferenceToken</maml:name> <maml:Description> <maml:para>A reference token correlating the warning with the relevant detailed logs. Should be sent to the service provider when reporting issues</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LocalizableWarningPack = Initialize-VcfLocalizableWarningPack -WarningCode "MyWarningCode" -LocalBundle "MyLocalBundle" -VipComponent "MyVipComponent" -DefaultMessage "MyDefaultMessage" -Arguments "MyArguments" -ReferenceToken "MyReferenceToken" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLocalizableWarningPack with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LocalizableWarningPack = Initialize-VcfLocalizableWarningPack -WarningCode "MyWarningCode" -LocalBundle "MyLocalBundle" -VipComponent "MyVipComponent" -DefaultMessage "MyDefaultMessage" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLocalizableWarningPack with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/LocalizableWarningPack</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfLogs</command:name> <command:verb>Initialize</command:verb> <command:noun>Logs</command:noun> <maml:description> <maml:para>Logs of different components.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Logs of different components.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfLogs</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcLogs</maml:name> <maml:Description> <maml:para>Collect vCenter Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxLogs</maml:name> <maml:Description> <maml:para>Collect NSX Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsxLogs</maml:name> <maml:Description> <maml:para>Collect ESX Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WcpLogs</maml:name> <maml:Description> <maml:para>Collect WCP Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcManagerLogs</maml:name> <maml:Description> <maml:para>Collect SDDC Manager Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApiLogs</maml:name> <maml:Description> <maml:para>Collect API Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxrailManagerLogs</maml:name> <maml:Description> <maml:para>Collect VXRailManager Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SystemDebugLogs</maml:name> <maml:Description> <maml:para>Collect SystemDebug Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmScreenshots</maml:name> <maml:Description> <maml:para>Collect VMScreenshots.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VraLogs</maml:name> <maml:Description> <maml:para>[Deprecated] Collect VMware Aria Automation Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VropsLogs</maml:name> <maml:Description> <maml:para>[Deprecated] Collect VMware Aria Operations Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrliLogs</maml:name> <maml:Description> <maml:para>[Deprecated] Collect VMware Aria Operations for Logs Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrslcmLogs</maml:name> <maml:Description> <maml:para>[Deprecated] Collect VMware Aria Suite Lifecycle Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutomationLogs</maml:name> <maml:Description> <maml:para>Collect VMware Aria Automation support logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationsLogs</maml:name> <maml:Description> <maml:para>Collect VMware Aria Operations support logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationsForLogs</maml:name> <maml:Description> <maml:para>Collect VMware Aria Operations For Logs support logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LifecycleLogs</maml:name> <maml:Description> <maml:para>Collect VMware Aria Suite Lifecycle support logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcLogs</maml:name> <maml:Description> <maml:para>Collect vCenter Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxLogs</maml:name> <maml:Description> <maml:para>Collect NSX Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsxLogs</maml:name> <maml:Description> <maml:para>Collect ESX Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WcpLogs</maml:name> <maml:Description> <maml:para>Collect WCP Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcManagerLogs</maml:name> <maml:Description> <maml:para>Collect SDDC Manager Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApiLogs</maml:name> <maml:Description> <maml:para>Collect API Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxrailManagerLogs</maml:name> <maml:Description> <maml:para>Collect VXRailManager Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SystemDebugLogs</maml:name> <maml:Description> <maml:para>Collect SystemDebug Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmScreenshots</maml:name> <maml:Description> <maml:para>Collect VMScreenshots.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VraLogs</maml:name> <maml:Description> <maml:para>[Deprecated] Collect VMware Aria Automation Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VropsLogs</maml:name> <maml:Description> <maml:para>[Deprecated] Collect VMware Aria Operations Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrliLogs</maml:name> <maml:Description> <maml:para>[Deprecated] Collect VMware Aria Operations for Logs Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrslcmLogs</maml:name> <maml:Description> <maml:para>[Deprecated] Collect VMware Aria Suite Lifecycle Logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutomationLogs</maml:name> <maml:Description> <maml:para>Collect VMware Aria Automation support logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationsLogs</maml:name> <maml:Description> <maml:para>Collect VMware Aria Operations support logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationsForLogs</maml:name> <maml:Description> <maml:para>Collect VMware Aria Operations For Logs support logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LifecycleLogs</maml:name> <maml:Description> <maml:para>Collect VMware Aria Suite Lifecycle support logs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Logs = Initialize-VcfLogs -VcLogs $false -NsxLogs $false -EsxLogs $false -WcpLogs $false -SddcManagerLogs $false -ApiLogs $false -VxrailManagerLogs $false -SystemDebugLogs $false -VmScreenshots $false -VraLogs $false -VropsLogs $false -VrliLogs $false -VrslcmLogs $false -AutomationLogs $false -OperationsLogs $false -OperationsForLogs $false -LifecycleLogs $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLogs with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Logs = Initialize-VcfLogs </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfLogs with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Logs</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfManifest</command:name> <command:verb>Initialize</command:verb> <command:noun>Manifest</command:noun> <maml:description> <maml:para>LCM 2.0 Manifest model that represents the metadata of the VMware Cloud foundation components and releases that Lyfe cycle manager utilises.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>LCM 2.0 Manifest model that represents the metadata of the VMware Cloud foundation components and releases that Lyfe cycle manager utilises.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfManifest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Manifest version supported by VCF</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para>Manifest sequence number which signifies an update in manifest</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTime</maml:name> <maml:Description> <maml:para>Creation time for the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PublishedDate</maml:name> <maml:Description> <maml:para>Date of publish of the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Releases</maml:name> <maml:Description> <maml:para>Releases of VCF in the ascending order of product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Release></command:parameterValue> <dev:type> <maml:name>List<Release></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RecalledBundles</maml:name> <maml:Description> <maml:para>Collection of bundles that are recalled and their replacements, if applicable</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BundleRecall></command:parameterValue> <dev:type> <maml:name>List<BundleRecall></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcManagerReleases</maml:name> <maml:Description> <maml:para>Product releases in the ascending order of product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SddcManagerRelease></command:parameterValue> <dev:type> <maml:name>List<SddcManagerRelease></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AsyncPatches</maml:name> <maml:Description> <maml:para>Async patches used by Async Patch Tool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<AsyncPatch>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<AsyncPatch>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VvsMappings</maml:name> <maml:Description> <maml:para>VVS product release Id to VCF version mapping</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, Dictionary<string, VvsVersionAliases>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, Dictionary<string, VvsVersionAliases>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Manifest version supported by VCF</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para>Manifest sequence number which signifies an update in manifest</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTime</maml:name> <maml:Description> <maml:para>Creation time for the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PublishedDate</maml:name> <maml:Description> <maml:para>Date of publish of the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Releases</maml:name> <maml:Description> <maml:para>Releases of VCF in the ascending order of product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Release></command:parameterValue> <dev:type> <maml:name>List<Release></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RecalledBundles</maml:name> <maml:Description> <maml:para>Collection of bundles that are recalled and their replacements, if applicable</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BundleRecall></command:parameterValue> <dev:type> <maml:name>List<BundleRecall></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcManagerReleases</maml:name> <maml:Description> <maml:para>Product releases in the ascending order of product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SddcManagerRelease></command:parameterValue> <dev:type> <maml:name>List<SddcManagerRelease></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AsyncPatches</maml:name> <maml:Description> <maml:para>Async patches used by Async Patch Tool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<AsyncPatch>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<AsyncPatch>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VvsMappings</maml:name> <maml:Description> <maml:para>VVS product release Id to VCF version mapping</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, Dictionary<string, VvsVersionAliases>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, Dictionary<string, VvsVersionAliases>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" -ReleaseURL "MyReleaseURL" -AdditionalMetadata "MyAdditionalMetadata" $SkuSpecificPatchBundles = Initialize-VcfSkuSpecificPatchBundles -BundleType "MyBundleType" -BundleVersion "MyBundleVersion" -_Version "My_Version" $SkuBomDetails = Initialize-VcfSkuBomDetails -Name "MyName" -Description "MyDescription" -SkuSpecificPatchBundles $SkuSpecificPatchBundles -Bom $ProductVersion $ReleaseUpdate = Initialize-VcfReleaseUpdate -Id "MyId" -ProductName "MyProductName" -BaseProductVersion "MyBaseProductVersion" -Description "MyDescription" -ReleaseUpdateURL "MyReleaseUpdateURL" -ReleaseDate "MyReleaseDate" $PatchBundle = Initialize-VcfPatchBundle -BundleId "MyBundleId" -BundleType "MyBundleType" -BundleElements "MyBundleElements" -CumulativeFromVcfVersion "MyCumulativeFromVcfVersion" $Release = Initialize-VcfRelease -Product "MyProduct" -_Version "My_Version" -MinCompatibleVcfVersion "MyMinCompatibleVcfVersion" -Description "MyDescription" -ReleaseDate "MyReleaseDate" -Bom $ProductVersion -IsApplicable $false -NotApplicableReason "MyNotApplicableReason" -Sku $SkuBomDetails -Updates $ReleaseUpdate -PatchBundles $PatchBundle -Eol "MyEol" -UpgradeOrder "MyUpgradeOrder" $BundleRecall = Initialize-VcfBundleRecall -RecalledBundleIds "MyRecalledBundleIds" -ReplacementBundleStatus "One among: NONE, PENDING, READY" -ReplacementBundleIds "MyReplacementBundleIds" $SddcManagerRelease = Initialize-VcfSddcManagerRelease -_Version "My_Version" -Description "MyDescription" -AdditionalMetadata "MyAdditionalMetadata" -BundleId "MyBundleId" -ReleaseDate 0 -CumulativeFromVcfVersion "MyCumulativeFromVcfVersion" $Manifest = Initialize-VcfManifest -_Version 0 -SequenceNumber 0 -CreationTime "MyCreationTime" -PublishedDate "MyPublishedDate" -Releases $Release -RecalledBundles $BundleRecall -SddcManagerReleases $SddcManagerRelease -AsyncPatches @{ key_example = $AsyncPatch = Initialize-VcfAsyncPatch -ProductVersion "MyProductVersion" -SupportedSkuTypes "One among: VXRAIL, VSAN" -InputSpecUrl "MyInputSpecUrl" -SddcHotPatchInfo @{ key_example = $SddcHotPatchInfo = Initialize-VcfSddcHotPatchInfo -_Version "My_Version" -SddcHotPatchMinTargetVcfVersion "MySddcHotPatchMinTargetVcfVersion" } } -VvsMappings @{ key_example = @{ key_example = $VvsVersionAliases = Initialize-VcfVvsVersionAliases -_Version "My_Version" -Aliases "MyAliases" } } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfManifest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" $Release = Initialize-VcfRelease -Product "MyProduct" -_Version "My_Version" -MinCompatibleVcfVersion "MyMinCompatibleVcfVersion" -Description "MyDescription" -ReleaseDate "MyReleaseDate" -Bom $ProductVersion $Manifest = Initialize-VcfManifest -_Version 0 -SequenceNumber 0 -CreationTime "MyCreationTime" -PublishedDate "MyPublishedDate" -Releases $Release </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfManifest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Manifest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetManifest</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetManifest</command:noun> <maml:description> <maml:para>Get manifest</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get manifest. There should be only one valid manifest in the System.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetManifest</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Manifest</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetManifest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetManifest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetManifest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetManifest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/manifests/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfSaveManifest</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfSaveManifest</command:noun> <maml:description> <maml:para>Save/Load manifest</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Save/Load manifest. Make sure manifest is a valid one. If manifest already exists, it gets overridden.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfSaveManifest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Manifest</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Manifest</command:parameterValue> <dev:type> <maml:name>Manifest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Manifest</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Manifest</command:parameterValue> <dev:type> <maml:name>Manifest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" -ReleaseURL "MyReleaseURL" -AdditionalMetadata "MyAdditionalMetadata" $SkuSpecificPatchBundles = Initialize-VcfSkuSpecificPatchBundles -BundleType "MyBundleType" -BundleVersion "MyBundleVersion" -_Version "My_Version" $SkuBomDetails = Initialize-VcfSkuBomDetails -Name "MyName" -Description "MyDescription" -SkuSpecificPatchBundles $SkuSpecificPatchBundles -Bom $ProductVersion $ReleaseUpdate = Initialize-VcfReleaseUpdate -Id "MyId" -ProductName "MyProductName" -BaseProductVersion "MyBaseProductVersion" -Description "MyDescription" -ReleaseUpdateURL "MyReleaseUpdateURL" -ReleaseDate "MyReleaseDate" $PatchBundle = Initialize-VcfPatchBundle -BundleId "MyBundleId" -BundleType "MyBundleType" -BundleElements "MyBundleElements" -CumulativeFromVcfVersion "MyCumulativeFromVcfVersion" $Release = Initialize-VcfRelease -Product "MyProduct" -_Version "My_Version" -MinCompatibleVcfVersion "MyMinCompatibleVcfVersion" -Description "MyDescription" -ReleaseDate "MyReleaseDate" -Bom $ProductVersion -IsApplicable $false -NotApplicableReason "MyNotApplicableReason" -Sku $SkuBomDetails -Updates $ReleaseUpdate -PatchBundles $PatchBundle -Eol "MyEol" -UpgradeOrder "MyUpgradeOrder" $BundleRecall = Initialize-VcfBundleRecall -RecalledBundleIds "MyRecalledBundleIds" -ReplacementBundleStatus "One among: NONE, PENDING, READY" -ReplacementBundleIds "MyReplacementBundleIds" $SddcManagerRelease = Initialize-VcfSddcManagerRelease -_Version "My_Version" -Description "MyDescription" -AdditionalMetadata "MyAdditionalMetadata" -BundleId "MyBundleId" -ReleaseDate 0 -CumulativeFromVcfVersion "MyCumulativeFromVcfVersion" $Manifest = Initialize-VcfManifest -_Version 0 -SequenceNumber 0 -CreationTime "MyCreationTime" -PublishedDate "MyPublishedDate" -Releases $Release -RecalledBundles $BundleRecall -SddcManagerReleases $SddcManagerRelease -AsyncPatches @{ key_example = $AsyncPatch = Initialize-VcfAsyncPatch -ProductVersion "MyProductVersion" -SupportedSkuTypes "One among: VXRAIL, VSAN" -InputSpecUrl "MyInputSpecUrl" -SddcHotPatchInfo @{ key_example = $SddcHotPatchInfo = Initialize-VcfSddcHotPatchInfo -_Version "My_Version" -SddcHotPatchMinTargetVcfVersion "MySddcHotPatchMinTargetVcfVersion" } } -VvsMappings @{ key_example = @{ key_example = $VvsVersionAliases = Initialize-VcfVvsVersionAliases -_Version "My_Version" -Aliases "MyAliases" } } Invoke-VcfSaveManifest -manifest $manifest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfSaveManifest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" $Release = Initialize-VcfRelease -Product "MyProduct" -_Version "My_Version" -MinCompatibleVcfVersion "MyMinCompatibleVcfVersion" -Description "MyDescription" -ReleaseDate "MyReleaseDate" -Bom $ProductVersion $Manifest = Initialize-VcfManifest -_Version 0 -SequenceNumber 0 -CreationTime "MyCreationTime" -PublishedDate "MyPublishedDate" -Releases $Release Invoke-VcfSaveManifest -manifest $manifest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfSaveManifest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/manifests/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfManifest</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfMicrosoftCertificateAuthoritySpec</command:name> <command:verb>Initialize</command:verb> <command:noun>MicrosoftCertificateAuthoritySpec</command:noun> <maml:description> <maml:para>This specification contains Microsoft CA configuration details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains Microsoft CA configuration details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfMicrosoftCertificateAuthoritySpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>CA server username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Secret</maml:name> <maml:Description> <maml:para>CA server password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServerUrl</maml:name> <maml:Description> <maml:para>CA server url</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TemplateName</maml:name> <maml:Description> <maml:para>CA server template name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>CA server username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Secret</maml:name> <maml:Description> <maml:para>CA server password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServerUrl</maml:name> <maml:Description> <maml:para>CA server url</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TemplateName</maml:name> <maml:Description> <maml:para>CA server template name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$MicrosoftCertificateAuthoritySpec = Initialize-VcfMicrosoftCertificateAuthoritySpec -Username "Administrator" -Secret "********" -ServerUrl "https://sfo-ad.rainpole.io/certsrv" -TemplateName "WebServer" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfMicrosoftCertificateAuthoritySpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$MicrosoftCertificateAuthoritySpec = Initialize-VcfMicrosoftCertificateAuthoritySpec -Username "Administrator" -Secret "********" -ServerUrl "https://sfo-ad.rainpole.io/certsrv" -TemplateName "WebServer" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfMicrosoftCertificateAuthoritySpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/MicrosoftCertificateAuthoritySpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-Vcf_Version</command:name> <command:verb>Initialize</command:verb> <command:noun>_Version</command:noun> <maml:description> <maml:para>ESX Quick Patch compatible source image version details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>ESX Quick Patch compatible source image version details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-Vcf_Version</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Source Image full version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayVersion</maml:name> <maml:Description> <maml:para>Source Image display version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Source Image full version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayVersion</maml:name> <maml:Description> <maml:para>Source Image display version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ModelVersion = Initialize-VcfModelVersion -_Version "8.0.3-0.0.23174786" -DisplayVersion "8.0 Update 3 - 23174786" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-Vcf_Version with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ModelVersion = Initialize-VcfModelVersion -_Version "8.0.3-0.0.23174786" -DisplayVersion "8.0 Update 3 - 23174786" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-Vcf_Version with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ModelVersion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNasVolumeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NasVolumeSpec</command:noun> <maml:description> <maml:para>NAS configuration for NFS based cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NAS configuration for NFS based cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNasVolumeSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServerName</maml:name> <maml:Description> <maml:para>NFS Server name used for cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Shared directory path used for NFS based cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReadOnly</maml:name> <maml:Description> <maml:para>Readonly is used to identify whether to mount the directory as readOnly or not</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserTag</maml:name> <maml:Description> <maml:para>User tag used to annotate NFS share</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServerName</maml:name> <maml:Description> <maml:para>NFS Server name used for cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Shared directory path used for NFS based cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReadOnly</maml:name> <maml:Description> <maml:para>Readonly is used to identify whether to mount the directory as readOnly or not</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserTag</maml:name> <maml:Description> <maml:para>User tag used to annotate NFS share</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNasVolumeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNasVolumeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NasVolumeSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNetwork</command:name> <command:verb>Initialize</command:verb> <command:noun>Network</command:noun> <maml:description> <maml:para>Represents a network in a network pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a network in a network pool</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNetwork</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Network Type of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VlanId</maml:name> <maml:Description> <maml:para>VLAN ID associated with the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mtu</maml:name> <maml:Description> <maml:para>MTU of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Subnet</maml:name> <maml:Description> <maml:para>Subnet associated with the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mask</maml:name> <maml:Description> <maml:para>Subnet mask for the subnet of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>Gateway for the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpPools</maml:name> <maml:Description> <maml:para>List of IP pool ranges to use</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpPool></command:parameterValue> <dev:type> <maml:name>List<IpPool></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FreeIps</maml:name> <maml:Description> <maml:para>List of free IPs to use</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UsedIps</maml:name> <maml:Description> <maml:para>List of used IPs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Network Type of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VlanId</maml:name> <maml:Description> <maml:para>VLAN ID associated with the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mtu</maml:name> <maml:Description> <maml:para>MTU of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Subnet</maml:name> <maml:Description> <maml:para>Subnet associated with the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mask</maml:name> <maml:Description> <maml:para>Subnet mask for the subnet of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>Gateway for the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpPools</maml:name> <maml:Description> <maml:para>List of IP pool ranges to use</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpPool></command:parameterValue> <dev:type> <maml:name>List<IpPool></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FreeIps</maml:name> <maml:Description> <maml:para>List of free IPs to use</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UsedIps</maml:name> <maml:Description> <maml:para>List of used IPs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetwork with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Network = Initialize-VcfNetwork -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetwork with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Network</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNetworkDetailsSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NetworkDetailsSpec</command:noun> <maml:description> <maml:para>This specification contains network parameters required for new virtual machines being added to a workload domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains network parameters required for new virtual machines being added to a workload domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNetworkDetailsSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IPv4 address of the virtual machine. Can be omitted if hostname (dnsName) is provded.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsName</maml:name> <maml:Description> <maml:para>DNS name of the virtual machine, e.g., vc-1.domain1.vsphere.local</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>IPv4 gateway the VM can use to connect to the outside world</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubnetMask</maml:name> <maml:Description> <maml:para>Subnet mask</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IPv4 address of the virtual machine. Can be omitted if hostname (dnsName) is provded.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsName</maml:name> <maml:Description> <maml:para>DNS name of the virtual machine, e.g., vc-1.domain1.vsphere.local</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>IPv4 gateway the VM can use to connect to the outside world</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubnetMask</maml:name> <maml:Description> <maml:para>Subnet mask</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkDetailsSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -DnsName "MyDnsName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkDetailsSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NetworkDetailsSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNetworkPool</command:name> <command:verb>Initialize</command:verb> <command:noun>NetworkPool</command:noun> <maml:description> <maml:para>Represents a network pool in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a network pool in the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNetworkPool</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>User specified name of the network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Networks</maml:name> <maml:Description> <maml:para>Representing the networks associated with the network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Network></command:parameterValue> <dev:type> <maml:name>List<Network></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>User specified name of the network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Networks</maml:name> <maml:Description> <maml:para>Representing the networks associated with the network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Network></command:parameterValue> <dev:type> <maml:name>List<Network></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $NetworkPool = Initialize-VcfNetworkPool -Id "MyId" -Name "MyName" -Networks $Network </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Network = Initialize-VcfNetwork -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" $NetworkPool = Initialize-VcfNetworkPool -Name "MyName" -Networks $Network </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NetworkPool</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddIpPoolToNetworkOfNetworkPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddIpPoolToNetworkOfNetworkPool</command:noun> <maml:description> <maml:para>Add an IP Pool to a Network of a Network Pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add an IP Pool to a Network of a Network Pool</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddIpPoolToNetworkOfNetworkPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the networkpoolk</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkId</maml:name> <maml:Description> <maml:para>Id of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpPool</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpPool</command:parameterValue> <dev:type> <maml:name>IpPool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the networkpoolk</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkId</maml:name> <maml:Description> <maml:para>Id of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpPool</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpPool</command:parameterValue> <dev:type> <maml:name>IpPool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Network</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" Invoke-VcfAddIpPoolToNetworkOfNetworkPool -id "Myid" -networkId "MynetworkId" -ipPool $ipPool </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddIpPoolToNetworkOfNetworkPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" Invoke-VcfAddIpPoolToNetworkOfNetworkPool -id "Myid" -networkId "MynetworkId" -ipPool $ipPool </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddIpPoolToNetworkOfNetworkPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/network-pools/id/networks/networkid/ip-pools/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIpPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCreateNetworkPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCreateNetworkPool</command:noun> <maml:description> <maml:para>Create a Network Pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a Network Pool</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCreateNetworkPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkPool</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkPool</command:parameterValue> <dev:type> <maml:name>NetworkPool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkPool</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkPool</command:parameterValue> <dev:type> <maml:name>NetworkPool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NetworkPool</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $NetworkPool = Initialize-VcfNetworkPool -Id "MyId" -Name "MyName" -Networks $Network Invoke-VcfCreateNetworkPool -networkPool $networkPool </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateNetworkPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Network = Initialize-VcfNetwork -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" $NetworkPool = Initialize-VcfNetworkPool -Name "MyName" -Networks $Network Invoke-VcfCreateNetworkPool -networkPool $networkPool </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateNetworkPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/network-pools/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNetworkPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteIpPoolFromNetworkOfNetworkPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteIpPoolFromNetworkOfNetworkPool</command:noun> <maml:description> <maml:para>Delete an IP Pool from a Network of a Network Pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete an IP Pool from a Network of a Network Pool</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteIpPoolFromNetworkOfNetworkPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the networkpool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkId</maml:name> <maml:Description> <maml:para>ID of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpPool</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpPool</command:parameterValue> <dev:type> <maml:name>IpPool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the networkpool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkId</maml:name> <maml:Description> <maml:para>ID of the network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpPool</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpPool</command:parameterValue> <dev:type> <maml:name>IpPool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" Invoke-VcfDeleteIpPoolFromNetworkOfNetworkPool -id "Myid" -networkId "MynetworkId" -ipPool $ipPool </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteIpPoolFromNetworkOfNetworkPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" Invoke-VcfDeleteIpPoolFromNetworkOfNetworkPool -id "Myid" -networkId "MynetworkId" -ipPool $ipPool </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteIpPoolFromNetworkOfNetworkPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/network-pools/id/networks/networkid/ip-pools/delete/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIpPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteNetworkPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteNetworkPool</command:noun> <maml:description> <maml:para>Delete a Network Pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete the Network Pool by the ID, if it exists and is unused</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteNetworkPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Force removal of Network Pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Force removal of Network Pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteNetworkPool -id "Myid" -force $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteNetworkPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteNetworkPool -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteNetworkPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/network-pools/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNetworkOfNetworkPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNetworkOfNetworkPool</command:noun> <maml:description> <maml:para>Get a Network of a Network Pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Network that is part of a Network Pool</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNetworkOfNetworkPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the Network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkId</maml:name> <maml:Description> <maml:para>Id of the Network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the Network pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkId</maml:name> <maml:Description> <maml:para>Id of the Network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Network</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNetworkOfNetworkPool -id "Myid" -networkId "MynetworkId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNetworkOfNetworkPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNetworkOfNetworkPool -id "Myid" -networkId "MynetworkId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNetworkOfNetworkPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/network-pools/id/networks/networkid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNetworkPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNetworkPool</command:noun> <maml:description> <maml:para>Get the list of all Network Pools</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Network Pools</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNetworkPool</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfNetworkPool</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNetworkPool </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNetworkPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNetworkPool </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNetworkPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/network-pools/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNetworkPoolByID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNetworkPoolByID</command:noun> <maml:description> <maml:para>Get a Network Pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Network Pool by ID, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNetworkPoolByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the network pool to fetch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the network pool to fetch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NetworkPool</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNetworkPoolByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNetworkPoolByID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNetworkPoolByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNetworkPoolByID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/network-pools/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNetworksOfNetworkPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNetworksOfNetworkPool</command:noun> <maml:description> <maml:para>Get the Networks of a Network Pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Networks that are part of a Network Pool</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNetworksOfNetworkPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID for Networkpool to get the networks from</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID for Networkpool to get the networks from</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfNetwork</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNetworksOfNetworkPool -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNetworksOfNetworkPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNetworksOfNetworkPool -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNetworksOfNetworkPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/network-pools/id/networks/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateNetworkPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateNetworkPool</command:noun> <maml:description> <maml:para>Update Network Pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Network Pool by ID, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateNetworkPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Network Pool ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkPoolUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkPoolUpdateSpec</command:parameterValue> <dev:type> <maml:name>NetworkPoolUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Network Pool ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkPoolUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkPoolUpdateSpec</command:parameterValue> <dev:type> <maml:name>NetworkPoolUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NetworkPool</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NetworkPoolUpdateSpec = Initialize-VcfNetworkPoolUpdateSpec -Name "MyName" Invoke-VcfUpdateNetworkPool -id "Myid" -networkPoolUpdateSpec $networkPoolUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateNetworkPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NetworkPoolUpdateSpec = Initialize-VcfNetworkPoolUpdateSpec -Name "MyName" Invoke-VcfUpdateNetworkPool -id "Myid" -networkPoolUpdateSpec $networkPoolUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateNetworkPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/network-pools/id/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNetworkPoolUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNetworkPoolUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NetworkPoolUpdateSpec</command:noun> <maml:description> <maml:para>Network Pool update data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Network Pool update data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNetworkPoolUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the Network Pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the Network Pool</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NetworkPoolUpdateSpec = Initialize-VcfNetworkPoolUpdateSpec -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkPoolUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NetworkPoolUpdateSpec = Initialize-VcfNetworkPoolUpdateSpec -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkPoolUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NetworkPoolUpdateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNetworkProfile</command:name> <command:verb>Initialize</command:verb> <command:noun>NetworkProfile</command:noun> <maml:description> <maml:para>This specification contains the host switch configurations for the NSX transport node.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the host switch configurations for the NSX transport node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNetworkProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The network profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The network profile description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsDefault</maml:name> <maml:Description> <maml:para>Designates the network profile as a Global Network Config or Sub Network Config</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtHostSwitchConfigs</maml:name> <maml:Description> <maml:para>The list of NSX host switch configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtHostSwitchConfig></command:parameterValue> <dev:type> <maml:name>List<NsxtHostSwitchConfig></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The network profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The network profile description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsDefault</maml:name> <maml:Description> <maml:para>Designates the network profile as a Global Network Config or Sub Network Config</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtHostSwitchConfigs</maml:name> <maml:Description> <maml:para>The list of NSX host switch configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtHostSwitchConfig></command:parameterValue> <dev:type> <maml:name>List<NsxtHostSwitchConfig></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkProfile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkProfile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NetworkProfile</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNetworkSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NetworkSpec</command:noun> <maml:description> <maml:para>This specification contains cluster's network configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains cluster's network configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNetworkSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsSpecs</maml:name> <maml:Description> <maml:para>Distributed switches to add to the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VdsSpec></command:parameterValue> <dev:type> <maml:name>List<VdsSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxClusterSpec</command:parameterValue> <dev:type> <maml:name>NsxClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkProfiles</maml:name> <maml:Description> <maml:para>The list of network profiles</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NetworkProfile></command:parameterValue> <dev:type> <maml:name>List<NetworkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsSpecs</maml:name> <maml:Description> <maml:para>Distributed switches to add to the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VdsSpec></command:parameterValue> <dev:type> <maml:name>List<VdsSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxClusterSpec</command:parameterValue> <dev:type> <maml:name>NsxClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkProfiles</maml:name> <maml:Description> <maml:para>The list of network profiles</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NetworkProfile></command:parameterValue> <dev:type> <maml:name>List<NetworkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $NetworkProfile = Initialize-VcfNetworkProfile -Name "MyName" -Description "MyDescription" -IsDefault $false -NsxtHostSwitchConfigs $NsxtHostSwitchConfig $NetworkSpec = Initialize-VcfNetworkSpec -VdsSpecs $VdsSpec -NsxClusterSpec $NsxClusterSpec -NetworkProfiles $NetworkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NetworkSpec = Initialize-VcfNetworkSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNetworkSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NetworkSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxClusterSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNfsDatastoreSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NfsDatastoreSpec</command:noun> <maml:description> <maml:para>This specification contains cluster storage configuration for NFS</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains cluster storage configuration for NFS</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNfsDatastoreSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>Datastore name used for cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NasVolume</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NasVolumeSpec</command:parameterValue> <dev:type> <maml:name>NasVolumeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>Datastore name used for cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NasVolume</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NasVolumeSpec</command:parameterValue> <dev:type> <maml:name>NasVolumeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false -UserTag "MyUserTag" $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNfsDatastoreSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NasVolumeSpec = Initialize-VcfNasVolumeSpec -ServerName "MyServerName" -Path "MyPath" -ReadOnly $false $NfsDatastoreSpec = Initialize-VcfNfsDatastoreSpec -DatastoreName "MyDatastoreName" -NasVolume $NasVolumeSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNfsDatastoreSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NfsDatastoreSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNasVolumeSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNiocBandwidthAllocationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NiocBandwidthAllocationSpec</command:noun> <maml:description> <maml:para>This specification contains network traffic per resource type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains network traffic per resource type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNiocBandwidthAllocationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>DvsHostInfrastructureTrafficResource resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NiocTrafficResourceAllocation</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NiocTrafficResourceAllocation</command:parameterValue> <dev:type> <maml:name>NiocTrafficResourceAllocation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>DvsHostInfrastructureTrafficResource resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NiocTrafficResourceAllocation</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NiocTrafficResourceAllocation</command:parameterValue> <dev:type> <maml:name>NiocTrafficResourceAllocation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNiocBandwidthAllocationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNiocBandwidthAllocationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NiocBandwidthAllocationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNiocTrafficResourceAllocation</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNiocTrafficResourceAllocation</command:name> <command:verb>Initialize</command:verb> <command:noun>NiocTrafficResourceAllocation</command:noun> <maml:description> <maml:para>Specify network traffic allocation for a resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Specify network traffic allocation for a resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNiocTrafficResourceAllocation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SharesInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SharesInfo</command:parameterValue> <dev:type> <maml:name>SharesInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Reservation</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SharesInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SharesInfo</command:parameterValue> <dev:type> <maml:name>SharesInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Reservation</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNiocTrafficResourceAllocation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNiocTrafficResourceAllocation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NiocTrafficResourceAllocation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSharesInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteALBCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteALBCluster</command:noun> <maml:description> <maml:para>Deletes an NSX ALB Cluster by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteALBCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ALB Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceDelete</maml:name> <maml:Description> <maml:para>Force Delete ALB Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ALB Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceDelete</maml:name> <maml:Description> <maml:para>Force Delete ALB Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteALBCluster -id "Myid" -forceDelete $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteALBCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteALBCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteALBCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsx-alb-clusters/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetALBCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetALBCluster</command:noun> <maml:description> <maml:para>Retrieve an NSX ALB Cluster by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetALBCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ALB Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ALB Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NsxALBCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetALBCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetALBCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetALBCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetALBCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsx-alb-clusters/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetALBClusters</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetALBClusters</command:noun> <maml:description> <maml:para>Retrieve a list of NSX ALB Clusters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetALBClusters</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfNsxALBCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetALBClusters -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetALBClusters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetALBClusters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetALBClusters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsx-alb-clusters/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetALBClustersFormFactors</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetALBClustersFormFactors</command:noun> <maml:description> <maml:para>Retrieve a list of NSX ALB Clusters Form Factors</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetALBClustersFormFactors</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ALBControllerNodeFormFactors</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetALBClustersFormFactors </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetALBClustersFormFactors with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetALBClustersFormFactors </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetALBClustersFormFactors with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsx-alb-clusters/form-factors/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateALBClusterCreationSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateALBClusterCreationSpec</command:noun> <maml:description> <maml:para>Perform validiation of the NsxAlbControllerClusterSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateALBClusterCreationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxAlbControllerClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxAlbControllerClusterSpec</command:parameterValue> <dev:type> <maml:name>NsxAlbControllerClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipCompatibilityCheck</maml:name> <maml:Description> <maml:para>Pass an optional Skip compatibility checks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxAlbControllerClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxAlbControllerClusterSpec</command:parameterValue> <dev:type> <maml:name>NsxAlbControllerClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipCompatibilityCheck</maml:name> <maml:Description> <maml:para>Pass an optional Skip compatibility checks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxAlbControllerNodeSpec = Initialize-VcfNsxAlbControllerNodeSpec -IpAddress "MyIpAddress" $NsxAlbControllerClusterSpec = Initialize-VcfNsxAlbControllerClusterSpec -DomainIds "MyDomainIds" -ClusterName "MyClusterName" -ClusterFqdn "MyClusterFqdn" -ClusterIpAddress "MyClusterIpAddress" -FormFactor "One among: LARGE, MEDIUM, SMALL" -AdminPassword "MyAdminPassword" -Nodes $NsxAlbControllerNodeSpec -BundleId "MyBundleId" Invoke-VcfValidateALBClusterCreationSpec -nsxAlbControllerClusterSpec $nsxAlbControllerClusterSpec -skipCompatibilityCheck $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateALBClusterCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxAlbControllerClusterSpec = Initialize-VcfNsxAlbControllerClusterSpec -DomainIds "MyDomainIds" -ClusterName "MyClusterName" -ClusterFqdn "MyClusterFqdn" -ClusterIpAddress "MyClusterIpAddress" -FormFactor "One among: LARGE, MEDIUM, SMALL" -AdminPassword "MyAdminPassword" Invoke-VcfValidateALBClusterCreationSpec -nsxAlbControllerClusterSpec $nsxAlbControllerClusterSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateALBClusterCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsx-alb-clusters/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxAlbControllerClusterSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateNsxALBCompatibility</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateNsxALBCompatibility</command:noun> <maml:description> <maml:para>Validate NSX ALB compatibility version</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateNsxALBCompatibility</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxAlbVersionValidationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxAlbVersionValidationSpec</command:parameterValue> <dev:type> <maml:name>NsxAlbVersionValidationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxAlbVersionValidationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxAlbVersionValidationSpec</command:parameterValue> <dev:type> <maml:name>NsxAlbVersionValidationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxAlbVersionValidationSpec = Initialize-VcfNsxAlbVersionValidationSpec -DomainIds "MyDomainIds" -BundleId "MyBundleId" Invoke-VcfValidateNsxALBCompatibility -nsxAlbVersionValidationSpec $nsxAlbVersionValidationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateNsxALBCompatibility with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxAlbVersionValidationSpec = Initialize-VcfNsxAlbVersionValidationSpec -DomainIds "MyDomainIds" -BundleId "MyBundleId" Invoke-VcfValidateNsxALBCompatibility -nsxAlbVersionValidationSpec $nsxAlbVersionValidationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateNsxALBCompatibility with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsx-alb-clusters/validations/version/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxAlbVersionValidationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxAlbControllerClusterSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxAlbControllerClusterSpec</command:noun> <maml:description> <maml:para>NSX Alb cluster creation data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NSX Alb cluster creation data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxAlbControllerClusterSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIds</maml:name> <maml:Description> <maml:para>IDs of the workload Domains where NSX Advanced Load Balancer Cluster will be deployed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterName</maml:name> <maml:Description> <maml:para>Name of NSX Advanced Load Balancer Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterFqdn</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Cluster fully qualified domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterIpAddress</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Cluster Virtual IPv4 address of format 'x.x.x.x'</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FormFactor</maml:name> <maml:Description> <maml:para>Size of NSX ALB cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdminPassword</maml:name> <maml:Description> <maml:para>Admin user password of NSX Advanced Load Balancer Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Nodes</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Cluster Controller Nodes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxAlbControllerNodeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxAlbControllerNodeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIds</maml:name> <maml:Description> <maml:para>IDs of the workload Domains where NSX Advanced Load Balancer Cluster will be deployed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterName</maml:name> <maml:Description> <maml:para>Name of NSX Advanced Load Balancer Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterFqdn</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Cluster fully qualified domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterIpAddress</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Cluster Virtual IPv4 address of format 'x.x.x.x'</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FormFactor</maml:name> <maml:Description> <maml:para>Size of NSX ALB cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdminPassword</maml:name> <maml:Description> <maml:para>Admin user password of NSX Advanced Load Balancer Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Nodes</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Cluster Controller Nodes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxAlbControllerNodeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxAlbControllerNodeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NsxAlbControllerNodeSpec = Initialize-VcfNsxAlbControllerNodeSpec -IpAddress "MyIpAddress" $NsxAlbControllerClusterSpec = Initialize-VcfNsxAlbControllerClusterSpec -DomainIds "MyDomainIds" -ClusterName "MyClusterName" -ClusterFqdn "MyClusterFqdn" -ClusterIpAddress "MyClusterIpAddress" -FormFactor "One among: LARGE, MEDIUM, SMALL" -AdminPassword "MyAdminPassword" -Nodes $NsxAlbControllerNodeSpec -BundleId "MyBundleId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxAlbControllerClusterSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NsxAlbControllerClusterSpec = Initialize-VcfNsxAlbControllerClusterSpec -DomainIds "MyDomainIds" -ClusterName "MyClusterName" -ClusterFqdn "MyClusterFqdn" -ClusterIpAddress "MyClusterIpAddress" -FormFactor "One among: LARGE, MEDIUM, SMALL" -AdminPassword "MyAdminPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxAlbControllerClusterSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxAlbControllerClusterSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxAlbControllerNodeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxAlbControllerNodeSpec</command:noun> <maml:description> <maml:para>NSX ALB Node representation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NSX ALB Node representation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxAlbControllerNodeSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IPv4 address of NSX Advanced Load Balancer Node</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IPv4 address of NSX Advanced Load Balancer Node</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxAlbControllerNodeSpec = Initialize-VcfNsxAlbControllerNodeSpec -IpAddress "MyIpAddress" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxAlbControllerNodeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxAlbControllerNodeSpec = Initialize-VcfNsxAlbControllerNodeSpec -IpAddress "MyIpAddress" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxAlbControllerNodeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxAlbControllerNodeSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxAlbVersionValidationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxAlbVersionValidationSpec</command:noun> <maml:description> <maml:para>NSX Alb cluster creation data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NSX Alb cluster creation data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxAlbVersionValidationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIds</maml:name> <maml:Description> <maml:para>IDs of the WorkLoadDomain where NSX Advanced Load Balancer Cluster will be deployed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIds</maml:name> <maml:Description> <maml:para>IDs of the WorkLoadDomain where NSX Advanced Load Balancer Cluster will be deployed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>NSX Advanced Load Balancer Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxAlbVersionValidationSpec = Initialize-VcfNsxAlbVersionValidationSpec -DomainIds "MyDomainIds" -BundleId "MyBundleId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxAlbVersionValidationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxAlbVersionValidationSpec = Initialize-VcfNsxAlbVersionValidationSpec -DomainIds "MyDomainIds" -BundleId "MyBundleId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxAlbVersionValidationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxAlbVersionValidationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxClusterSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxClusterSpec</command:noun> <maml:description> <maml:para>This specification contains NSX configuration for cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains NSX configuration for cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxClusterSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxTClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTClusterSpec</command:parameterValue> <dev:type> <maml:name>NsxTClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxTClusterSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTClusterSpec</command:parameterValue> <dev:type> <maml:name>NsxTClusterSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile $NsxClusterSpec = Initialize-VcfNsxClusterSpec -NsxTClusterSpec $NsxTClusterSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxClusterSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NsxClusterSpec = Initialize-VcfNsxClusterSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxClusterSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxClusterSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxTClusterSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxManagerSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxManagerSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to install and configure NSX Manager in a workload domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to install and configure NSX Manager in a workload domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxManagerSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the NSX Manager virtual machine</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkDetailsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkDetailsSpec</command:parameterValue> <dev:type> <maml:name>NetworkDetailsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the NSX Manager virtual machine</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkDetailsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkDetailsSpec</command:parameterValue> <dev:type> <maml:name>NetworkDetailsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" $NsxManagerSpec = Initialize-VcfNsxManagerSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxManagerSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -DnsName "MyDnsName" $NsxManagerSpec = Initialize-VcfNsxManagerSpec -NetworkDetailsSpec $NetworkDetailsSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxManagerSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxManagerSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNetworkDetailsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxStretchClusterSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxStretchClusterSpec</command:noun> <maml:description> <maml:para>This specification contains NSX configuration for Secondary AZ Hosts</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains NSX configuration for Secondary AZ Hosts</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxStretchClusterSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolsSpec</maml:name> <maml:Description> <maml:para>The IP address pool specifications</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkProfiles</maml:name> <maml:Description> <maml:para>The list of uplink profile specifications.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<UplinkProfile></command:parameterValue> <dev:type> <maml:name>List<UplinkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolsSpec</maml:name> <maml:Description> <maml:para>The IP address pool specifications</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkProfiles</maml:name> <maml:Description> <maml:para>The list of uplink profile specifications.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<UplinkProfile></command:parameterValue> <dev:type> <maml:name>List<UplinkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxStretchClusterSpec = Initialize-VcfNsxStretchClusterSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxStretchClusterSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec $NsxStretchClusterSpec = Initialize-VcfNsxStretchClusterSpec -UplinkProfiles $UplinkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxStretchClusterSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxStretchClusterSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfConnectOpenId</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfConnectOpenId</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfConnectOpenId</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtOidcSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxtOidcSpec</command:parameterValue> <dev:type> <maml:name>NsxtOidcSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtOidcSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxtOidcSpec</command:parameterValue> <dev:type> <maml:name>NsxtOidcSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxtOidcSpec = Initialize-VcfNsxtOidcSpec -EntityInventoryId "MyEntityInventoryId" -OidcType "vcenter" Invoke-VcfConnectOpenId -nsxtOidcSpec $nsxtOidcSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConnectOpenId with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxtOidcSpec = Initialize-VcfNsxtOidcSpec -EntityInventoryId "MyEntityInventoryId" -OidcType "vcenter" Invoke-VcfConnectOpenId -nsxtOidcSpec $nsxtOidcSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConnectOpenId with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/oidcs/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxtOidcSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNsxCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNsxCluster</command:noun> <maml:description> <maml:para>Retrieve the details of an NSX cluster by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNsxCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>NSX cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>NSX cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NsxTCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNsxClusterQueryResponse</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNsxClusterQueryResponse</command:noun> <maml:description> <maml:para>Get NSX cluster query response</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNsxClusterQueryResponse</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NsxTQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxClusterQueryResponse -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxClusterQueryResponse with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxClusterQueryResponse -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxClusterQueryResponse with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/queries/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNsxClusters</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNsxClusters</command:noun> <maml:description> <maml:para>Retrieve a list of NSX clusters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNsxClusters</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsShareable</maml:name> <maml:Description> <maml:para>filter NSX clusters which can be shared for domain creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsShareable</maml:name> <maml:Description> <maml:para>filter NSX clusters which can be shared for domain creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfNsxTCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxClusters -isShareable $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxClusters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxClusters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxClusters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNsxCriteria</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNsxCriteria</command:noun> <maml:description> <maml:para>Get all NSX criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNsxCriteria</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfNsxTCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxCriteria </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxCriteria with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxCriteria </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxCriteria with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/criteria/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNsxCriterion</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNsxCriterion</command:noun> <maml:description> <maml:para>Get a NSX criterion</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNsxCriterion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NsxTCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxCriterion -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxCriterion -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/criteria/name/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNsxIpAddressPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNsxIpAddressPool</command:noun> <maml:description> <maml:para>Retrieve an NSX IP Address Pool by its name</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNsxIpAddressPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtClusterId</maml:name> <maml:Description> <maml:para>NSX cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>IP address pool name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtClusterId</maml:name> <maml:Description> <maml:para>NSX cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>IP address pool name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NsxtIpAddressPool</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxIpAddressPool -nsxtClusterId "MynsxtClusterId" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxIpAddressPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxIpAddressPool -nsxtClusterId "MynsxtClusterId" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxIpAddressPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/nsxt-cluster-id/ip-address-pools/name/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNsxIpAddressPools</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNsxIpAddressPools</command:noun> <maml:description> <maml:para>Retrive a list of NSX IP Address Pools by the NSX cluster ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNsxIpAddressPools</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtClusterId</maml:name> <maml:Description> <maml:para>NSX cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtClusterId</maml:name> <maml:Description> <maml:para>NSX cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfNsxtIpAddressPool</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxIpAddressPools -nsxtClusterId "MynsxtClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxIpAddressPools with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxIpAddressPools -nsxtClusterId "MynsxtClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxIpAddressPools with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/nsxt-cluster-id/ip-address-pools/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNsxTransportZones</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNsxTransportZones</command:noun> <maml:description> <maml:para>Retrieve list of all NSX transport zones</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNsxTransportZones</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtClusterId</maml:name> <maml:Description> <maml:para>NSX cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtClusterId</maml:name> <maml:Description> <maml:para>NSX cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfNsxtTransportZoneInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxTransportZones -nsxtClusterId "MynsxtClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxTransportZones with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxTransportZones -nsxtClusterId "MynsxtClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxTransportZones with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/nsxt-cluster-id/transport-zones/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetValidationResult</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetValidationResult</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetValidationResult</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationResult -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationResult with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationResult -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationResult with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/ip-address-pools/validations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartNsxCriteriaQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartNsxCriteriaQuery</command:noun> <maml:description> <maml:para>Start a query with NSX Criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartNsxCriteriaQuery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxTCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTCriterion</command:parameterValue> <dev:type> <maml:name>NsxTCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxTCriterion</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxTCriterion</command:parameterValue> <dev:type> <maml:name>NsxTCriterion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NsxTQueryResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxTCriterion = Initialize-VcfNsxTCriterion -Name "NSXT_CLUSTERS_WITH_STATUS" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" Invoke-VcfStartNsxCriteriaQuery -nsxTCriterion $nsxTCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartNsxCriteriaQuery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxTCriterion = Initialize-VcfNsxTCriterion Invoke-VcfStartNsxCriteriaQuery -nsxTCriterion $nsxTCriterion </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartNsxCriteriaQuery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/queries/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxTCriterion</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateIpPool</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateIpPool</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateIpPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtIpAddressPoolValidationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxtIpAddressPoolValidationSpec</command:parameterValue> <dev:type> <maml:name>NsxtIpAddressPoolValidationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtIpAddressPoolValidationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxtIpAddressPoolValidationSpec</command:parameterValue> <dev:type> <maml:name>NsxtIpAddressPoolValidationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $NsxtIpAddressPoolValidationSpec = Initialize-VcfNsxtIpAddressPoolValidationSpec -IpAddressPoolSpec $IpAddressPoolSpec -NsxtClusterId "MyNsxtClusterId" Invoke-VcfValidateIpPool -nsxtIpAddressPoolValidationSpec $nsxtIpAddressPoolValidationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateIpPool with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" $NsxtIpAddressPoolValidationSpec = Initialize-VcfNsxtIpAddressPoolValidationSpec -IpAddressPoolSpec $IpAddressPoolSpec Invoke-VcfValidateIpPool -nsxtIpAddressPoolValidationSpec $nsxtIpAddressPoolValidationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateIpPool with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/nsxt-clusters/ip-address-pools/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxtIpAddressPoolValidationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxTClusterSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxTClusterSpec</command:noun> <maml:description> <maml:para>This specification contains NSX configuration for a new cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains NSX configuration for a new cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxTClusterSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GeneveVlanId</maml:name> <maml:Description> <maml:para>Vlan id of Geneve. (This field is deprecated, instead please use transportVlan in uplinkProfiles)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpAddressPoolSpec</command:parameterValue> <dev:type> <maml:name>IpAddressPoolSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolsSpec</maml:name> <maml:Description> <maml:para>The list of IP address pools specification</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkProfiles</maml:name> <maml:Description> <maml:para>The list of uplink profile specifications.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<UplinkProfile></command:parameterValue> <dev:type> <maml:name>List<UplinkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GeneveVlanId</maml:name> <maml:Description> <maml:para>Vlan id of Geneve. (This field is deprecated, instead please use transportVlan in uplinkProfiles)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpAddressPoolSpec</command:parameterValue> <dev:type> <maml:name>IpAddressPoolSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolsSpec</maml:name> <maml:Description> <maml:para>The list of IP address pools specification</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<IpAddressPoolSpec></command:parameterValue> <dev:type> <maml:name>List<IpAddressPoolSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkProfiles</maml:name> <maml:Description> <maml:para>The list of uplink profile specifications.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<UplinkProfile></command:parameterValue> <dev:type> <maml:name>List<UplinkProfile></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec -GeneveVlanId 0 -IpAddressPoolSpec $IpAddressPoolSpec -IpAddressPoolsSpec $IpAddressPoolSpec -UplinkProfiles $UplinkProfile </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTClusterSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NsxTClusterSpec = Initialize-VcfNsxTClusterSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTClusterSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxTClusterSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIpAddressPoolSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxTCriterion</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxTCriterion</command:noun> <maml:description> <maml:para>Represents a criterion for querying the NSX cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a criterion for querying the NSX cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxTCriterion</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Arguments</maml:name> <maml:Description> <maml:para>Arguments required for a particular criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the criterion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxTCriterion = Initialize-VcfNsxTCriterion -Name "NSXT_CLUSTERS_WITH_STATUS" -Arguments @{ key_example = "MyInner" } -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTCriterion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxTCriterion = Initialize-VcfNsxTCriterion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTCriterion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxTCriterion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxTEdgeClusterProfileSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxTEdgeClusterProfileSpec</command:noun> <maml:description> <maml:para>This specification contains edge cluster profile configurations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains edge cluster profile configurations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxTEdgeClusterProfileSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterProfileName</maml:name> <maml:Description> <maml:para>Name for the edge cluster profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BfdAllowedHop</maml:name> <maml:Description> <maml:para>BFD allowed Hop</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BfdDeclareDeadMultiple</maml:name> <maml:Description> <maml:para>BFD Declare Dead Multiple</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BfdProbeInterval</maml:name> <maml:Description> <maml:para>BFD Probe</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandbyRelocationThreshold</maml:name> <maml:Description> <maml:para>Standby Relocation Threshold</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterProfileName</maml:name> <maml:Description> <maml:para>Name for the edge cluster profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BfdAllowedHop</maml:name> <maml:Description> <maml:para>BFD allowed Hop</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BfdDeclareDeadMultiple</maml:name> <maml:Description> <maml:para>BFD Declare Dead Multiple</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BfdProbeInterval</maml:name> <maml:Description> <maml:para>BFD Probe</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandbyRelocationThreshold</maml:name> <maml:Description> <maml:para>Standby Relocation Threshold</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxTEdgeClusterProfileSpec = Initialize-VcfNsxTEdgeClusterProfileSpec -EdgeClusterProfileName "MyEdgeClusterProfileName" -BfdAllowedHop 0 -BfdDeclareDeadMultiple 0 -BfdProbeInterval 0 -StandbyRelocationThreshold 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTEdgeClusterProfileSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxTEdgeClusterProfileSpec = Initialize-VcfNsxTEdgeClusterProfileSpec -EdgeClusterProfileName "MyEdgeClusterProfileName" -BfdAllowedHop 0 -BfdDeclareDeadMultiple 0 -BfdProbeInterval 0 -StandbyRelocationThreshold 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTEdgeClusterProfileSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxTEdgeClusterProfileSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCreateEdgeCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCreateEdgeCluster</command:noun> <maml:description> <maml:para>Create an NSX Edge Cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCreateEdgeCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterCreationSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterCreationSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec -Name "MyName" -NsxId "MyNsxId" $BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" -PeerIP "MyPeerIP" -AsnPeer 0 -BgpPeerPassword "MyBgpPeerPassword" -BgpPeers $BgpPeerSpec $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -VmManagementPortgroupVlan 0 -VmManagementPortgroupName "MyVmManagementPortgroupName" -EdgeTepGateway "MyEdgeTepGateway" -EdgeTep1IP "MyEdgeTep1IP" -EdgeTep2IP "MyEdgeTep2IP" -EdgeTepIpAddressPool $EdgeTepIpAddressPoolSpec -EdgeTepVlan 0 -ClusterId "MyClusterId" -InterRackCluster $false -UplinkNetwork $NsxTEdgeUplinkNetwork -FirstNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" -SecondNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $NsxTEdgeClusterProfileSpec = Initialize-VcfNsxTEdgeClusterProfileSpec -EdgeClusterProfileName "MyEdgeClusterProfileName" -BfdAllowedHop 0 -BfdDeclareDeadMultiple 0 -BfdProbeInterval 0 -StandbyRelocationThreshold 0 $EdgeClusterCreationSpec = Initialize-VcfEdgeClusterCreationSpec -EdgeClusterName "MyEdgeClusterName" -EdgeClusterType "One among: NSX-T" -EdgeRootPassword "MyEdgeRootPassword" -EdgeAdminPassword "MyEdgeAdminPassword" -EdgeAuditPassword "MyEdgeAuditPassword" -EdgeFormFactor "One among: XLARGE, LARGE, MEDIUM, SMALL" -Tier0ServicesHighAvailability "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY" -Mtu 0 -Asn 0 -EdgeNodeSpecs $NsxTEdgeNodeSpec -NewIpAddressPoolSpecs $IpAddressPoolSpec -Tier0RoutingType "One among: EBGP, STATIC" -Tier0Name "MyTier0Name" -Tier1Name "MyTier1Name" -Tier1Unhosted $false -EdgeClusterProfileType "One among: DEFAULT, CUSTOM" -EdgeClusterProfileSpec $NsxTEdgeClusterProfileSpec -SkipTepRoutabilityCheck $false -TransitSubnets "MyTransitSubnets" -InternalTransitSubnets "MyInternalTransitSubnets" Invoke-VcfCreateEdgeCluster -edgeClusterCreationSpec $edgeClusterCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateEdgeCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -EdgeTepVlan 0 $NsxTEdgeClusterProfileSpec = Initialize-VcfNsxTEdgeClusterProfileSpec -EdgeClusterProfileName "MyEdgeClusterProfileName" -BfdAllowedHop 0 -BfdDeclareDeadMultiple 0 -BfdProbeInterval 0 -StandbyRelocationThreshold 0 $EdgeClusterCreationSpec = Initialize-VcfEdgeClusterCreationSpec -EdgeClusterName "MyEdgeClusterName" -EdgeClusterType "One among: NSX-T" -EdgeRootPassword "MyEdgeRootPassword" -EdgeAdminPassword "MyEdgeAdminPassword" -EdgeAuditPassword "MyEdgeAuditPassword" -EdgeFormFactor "One among: XLARGE, LARGE, MEDIUM, SMALL" -Mtu 0 -EdgeNodeSpecs $NsxTEdgeNodeSpec -EdgeClusterProfileType "One among: DEFAULT, CUSTOM" -EdgeClusterProfileSpec $NsxTEdgeClusterProfileSpec Invoke-VcfCreateEdgeCluster -edgeClusterCreationSpec $edgeClusterCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateEdgeCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/edge-clusters/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEdgeClusterCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetEdgeCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetEdgeCluster</command:noun> <maml:description> <maml:para>Retrieve an NSX Edge Cluster by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetEdgeCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Edge Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Edge Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>EdgeCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetEdgeCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetEdgeCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetEdgeCluster -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetEdgeCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/edge-clusters/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetEdgeClusterQueryCriteria</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetEdgeClusterQueryCriteria</command:noun> <maml:description> <maml:para>Get the Edge Cluster criterion list for the NSX query</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetEdgeClusterQueryCriteria</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterId</maml:name> <maml:Description> <maml:para>Edge Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterId</maml:name> <maml:Description> <maml:para>Edge Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfEdgeClusterNsxtEntityCriterion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetEdgeClusterQueryCriteria -edgeClusterId "MyedgeClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetEdgeClusterQueryCriteria with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetEdgeClusterQueryCriteria -edgeClusterId "MyedgeClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetEdgeClusterQueryCriteria with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/edge-clusters/edgeclusterid/criteria/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetEdgeClusterValidationByID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetEdgeClusterValidationByID</command:noun> <maml:description> <maml:para>Retrieve the results of a NSX Edge Cluster validation by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetEdgeClusterValidationByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetEdgeClusterValidationByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetEdgeClusterValidationByID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetEdgeClusterValidationByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetEdgeClusterValidationByID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/edge-clusters/validations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetEdgeClusters</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetEdgeClusters</command:noun> <maml:description> <maml:para>Retrieve a list of NSX Edge Clusters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetEdgeClusters</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Pass an optional vSphere Cluster ID to fetch edge clusters associated with the vSphere Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Pass an optional vSphere Cluster ID to fetch edge clusters associated with the vSphere Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfEdgeCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetEdgeClusters -clusterId "MyclusterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetEdgeClusters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetEdgeClusters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetEdgeClusters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/edge-clusters/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateEdgeCluster</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateEdgeCluster</command:noun> <maml:description> <maml:para>Expand or shrink an NSX Edge Cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateEdgeCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Edge Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterUpdateSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Edge Cluster ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterUpdateSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec -Name "MyName" -NsxId "MyNsxId" $BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" -PeerIP "MyPeerIP" -AsnPeer 0 -BgpPeerPassword "MyBgpPeerPassword" -BgpPeers $BgpPeerSpec $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -VmManagementPortgroupVlan 0 -VmManagementPortgroupName "MyVmManagementPortgroupName" -EdgeTepGateway "MyEdgeTepGateway" -EdgeTep1IP "MyEdgeTep1IP" -EdgeTep2IP "MyEdgeTep2IP" -EdgeTepIpAddressPool $EdgeTepIpAddressPoolSpec -EdgeTepVlan 0 -ClusterId "MyClusterId" -InterRackCluster $false -UplinkNetwork $NsxTEdgeUplinkNetwork -FirstNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" -SecondNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $EdgeClusterExpansionSpec = Initialize-VcfEdgeClusterExpansionSpec -EdgeNodeRootPassword "MyEdgeNodeRootPassword" -EdgeNodeAdminPassword "MyEdgeNodeAdminPassword" -EdgeNodeAuditPassword "MyEdgeNodeAuditPassword" -SkipTepRoutabilityCheck $false -EdgeNodeSpecs $NsxTEdgeNodeSpec -NewIpAddressPoolSpecs $IpAddressPoolSpec -AdditionalTier1Names "MyAdditionalTier1Names" -Tier1Unhosted $false $EdgeClusterShrinkageSpec = Initialize-VcfEdgeClusterShrinkageSpec -EdgeNodeIds "MyEdgeNodeIds" $EdgeClusterUpdateSpec = Initialize-VcfEdgeClusterUpdateSpec -EdgeClusterExpansionSpec $EdgeClusterExpansionSpec -EdgeClusterShrinkageSpec $EdgeClusterShrinkageSpec -Operation "One among: EXPANSION, SHRINKAGE" Invoke-VcfUpdateEdgeCluster -id "Myid" -edgeClusterUpdateSpec $edgeClusterUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateEdgeCluster with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$EdgeClusterUpdateSpec = Initialize-VcfEdgeClusterUpdateSpec -Operation "One among: EXPANSION, SHRINKAGE" Invoke-VcfUpdateEdgeCluster -id "Myid" -edgeClusterUpdateSpec $edgeClusterUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateEdgeCluster with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/edge-clusters/id/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEdgeClusterUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateEdgeClusterCreationSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateEdgeClusterCreationSpec</command:noun> <maml:description> <maml:para>Perform validiation of the EdgeClusterCreationSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateEdgeClusterCreationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterCreationSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterCreationSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec -Name "MyName" -NsxId "MyNsxId" $BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" -PeerIP "MyPeerIP" -AsnPeer 0 -BgpPeerPassword "MyBgpPeerPassword" -BgpPeers $BgpPeerSpec $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -VmManagementPortgroupVlan 0 -VmManagementPortgroupName "MyVmManagementPortgroupName" -EdgeTepGateway "MyEdgeTepGateway" -EdgeTep1IP "MyEdgeTep1IP" -EdgeTep2IP "MyEdgeTep2IP" -EdgeTepIpAddressPool $EdgeTepIpAddressPoolSpec -EdgeTepVlan 0 -ClusterId "MyClusterId" -InterRackCluster $false -UplinkNetwork $NsxTEdgeUplinkNetwork -FirstNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" -SecondNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $NsxTEdgeClusterProfileSpec = Initialize-VcfNsxTEdgeClusterProfileSpec -EdgeClusterProfileName "MyEdgeClusterProfileName" -BfdAllowedHop 0 -BfdDeclareDeadMultiple 0 -BfdProbeInterval 0 -StandbyRelocationThreshold 0 $EdgeClusterCreationSpec = Initialize-VcfEdgeClusterCreationSpec -EdgeClusterName "MyEdgeClusterName" -EdgeClusterType "One among: NSX-T" -EdgeRootPassword "MyEdgeRootPassword" -EdgeAdminPassword "MyEdgeAdminPassword" -EdgeAuditPassword "MyEdgeAuditPassword" -EdgeFormFactor "One among: XLARGE, LARGE, MEDIUM, SMALL" -Tier0ServicesHighAvailability "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY" -Mtu 0 -Asn 0 -EdgeNodeSpecs $NsxTEdgeNodeSpec -NewIpAddressPoolSpecs $IpAddressPoolSpec -Tier0RoutingType "One among: EBGP, STATIC" -Tier0Name "MyTier0Name" -Tier1Name "MyTier1Name" -Tier1Unhosted $false -EdgeClusterProfileType "One among: DEFAULT, CUSTOM" -EdgeClusterProfileSpec $NsxTEdgeClusterProfileSpec -SkipTepRoutabilityCheck $false -TransitSubnets "MyTransitSubnets" -InternalTransitSubnets "MyInternalTransitSubnets" Invoke-VcfValidateEdgeClusterCreationSpec -edgeClusterCreationSpec $edgeClusterCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateEdgeClusterCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -EdgeTepVlan 0 $NsxTEdgeClusterProfileSpec = Initialize-VcfNsxTEdgeClusterProfileSpec -EdgeClusterProfileName "MyEdgeClusterProfileName" -BfdAllowedHop 0 -BfdDeclareDeadMultiple 0 -BfdProbeInterval 0 -StandbyRelocationThreshold 0 $EdgeClusterCreationSpec = Initialize-VcfEdgeClusterCreationSpec -EdgeClusterName "MyEdgeClusterName" -EdgeClusterType "One among: NSX-T" -EdgeRootPassword "MyEdgeRootPassword" -EdgeAdminPassword "MyEdgeAdminPassword" -EdgeAuditPassword "MyEdgeAuditPassword" -EdgeFormFactor "One among: XLARGE, LARGE, MEDIUM, SMALL" -Mtu 0 -EdgeNodeSpecs $NsxTEdgeNodeSpec -EdgeClusterProfileType "One among: DEFAULT, CUSTOM" -EdgeClusterProfileSpec $NsxTEdgeClusterProfileSpec Invoke-VcfValidateEdgeClusterCreationSpec -edgeClusterCreationSpec $edgeClusterCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateEdgeClusterCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/edge-clusters/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEdgeClusterCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateEdgeClusterUpdateSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateEdgeClusterUpdateSpec</command:noun> <maml:description> <maml:para>Perform validation of the EdgeClusterUpdateSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateEdgeClusterUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>NSX Edge cluster id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterUpdateSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>NSX Edge cluster id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeClusterUpdateSpec</command:parameterValue> <dev:type> <maml:name>EdgeClusterUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec -Name "MyName" -NsxId "MyNsxId" $BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" -PeerIP "MyPeerIP" -AsnPeer 0 -BgpPeerPassword "MyBgpPeerPassword" -BgpPeers $BgpPeerSpec $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -VmManagementPortgroupVlan 0 -VmManagementPortgroupName "MyVmManagementPortgroupName" -EdgeTepGateway "MyEdgeTepGateway" -EdgeTep1IP "MyEdgeTep1IP" -EdgeTep2IP "MyEdgeTep2IP" -EdgeTepIpAddressPool $EdgeTepIpAddressPoolSpec -EdgeTepVlan 0 -ClusterId "MyClusterId" -InterRackCluster $false -UplinkNetwork $NsxTEdgeUplinkNetwork -FirstNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" -SecondNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $EdgeClusterExpansionSpec = Initialize-VcfEdgeClusterExpansionSpec -EdgeNodeRootPassword "MyEdgeNodeRootPassword" -EdgeNodeAdminPassword "MyEdgeNodeAdminPassword" -EdgeNodeAuditPassword "MyEdgeNodeAuditPassword" -SkipTepRoutabilityCheck $false -EdgeNodeSpecs $NsxTEdgeNodeSpec -NewIpAddressPoolSpecs $IpAddressPoolSpec -AdditionalTier1Names "MyAdditionalTier1Names" -Tier1Unhosted $false $EdgeClusterShrinkageSpec = Initialize-VcfEdgeClusterShrinkageSpec -EdgeNodeIds "MyEdgeNodeIds" $EdgeClusterUpdateSpec = Initialize-VcfEdgeClusterUpdateSpec -EdgeClusterExpansionSpec $EdgeClusterExpansionSpec -EdgeClusterShrinkageSpec $EdgeClusterShrinkageSpec -Operation "One among: EXPANSION, SHRINKAGE" Invoke-VcfValidateEdgeClusterUpdateSpec -id "Myid" -edgeClusterUpdateSpec $edgeClusterUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateEdgeClusterUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$EdgeClusterUpdateSpec = Initialize-VcfEdgeClusterUpdateSpec -Operation "One among: EXPANSION, SHRINKAGE" Invoke-VcfValidateEdgeClusterUpdateSpec -id "Myid" -edgeClusterUpdateSpec $edgeClusterUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateEdgeClusterUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/edge-clusters/id/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEdgeClusterUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxtEdgeClusterUpgradeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxtEdgeClusterUpgradeSpec</command:noun> <maml:description> <maml:para>Host transport node cluster upgrade input</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Host transport node cluster upgrade input</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxtEdgeClusterUpgradeSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterId</maml:name> <maml:Description> <maml:para>Resource ID of the edge transport node cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeParallelUpgrade</maml:name> <maml:Description> <maml:para>disable/enable parallel upgrade of edges within the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeClusterId</maml:name> <maml:Description> <maml:para>Resource ID of the edge transport node cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeParallelUpgrade</maml:name> <maml:Description> <maml:para>disable/enable parallel upgrade of edges within the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxtEdgeClusterUpgradeSpec = Initialize-VcfNsxtEdgeClusterUpgradeSpec -EdgeClusterId "MyEdgeClusterId" -EdgeParallelUpgrade $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtEdgeClusterUpgradeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxtEdgeClusterUpgradeSpec = Initialize-VcfNsxtEdgeClusterUpgradeSpec -EdgeClusterId "MyEdgeClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtEdgeClusterUpgradeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxtEdgeClusterUpgradeSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxTEdgeNodeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxTEdgeNodeSpec</command:noun> <maml:description> <maml:para>This specification contains configuration inputs required to deploy and configure an edge node</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains configuration inputs required to deploy and configure an edge node</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxTEdgeNodeSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeName</maml:name> <maml:Description> <maml:para>Edge Node Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ManagementIP</maml:name> <maml:Description> <maml:para>Management Interface IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ManagementGateway</maml:name> <maml:Description> <maml:para>Management Gateway IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmManagementPortgroupVlan</maml:name> <maml:Description> <maml:para>Management Vlan Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">uint?</command:parameterValue> <dev:type> <maml:name>uint?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmManagementPortgroupName</maml:name> <maml:Description> <maml:para>Management Network Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTepGateway</maml:name> <maml:Description> <maml:para>Edge TEP Gateway IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTep1IP</maml:name> <maml:Description> <maml:para>Edge TEP 1 IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTep2IP</maml:name> <maml:Description> <maml:para>Edge TEP 2 IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTepIpAddressPool</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeTepIpAddressPoolSpec</command:parameterValue> <dev:type> <maml:name>EdgeTepIpAddressPoolSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTepVlan</maml:name> <maml:Description> <maml:para>Edge TEP VLAN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>ID of vSphere cluster where the Edge node will be deployed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InterRackCluster</maml:name> <maml:Description> <maml:para>Is inter-rack cluster(true for L2 non-uniform and L3 : At least one of management, uplink, Edge and host TEP networks is different for hosts of the cluster, false for L2 uniform : All hosts in cluster have identical management, uplink, Edge and host TEP networks)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkNetwork</maml:name> <maml:Description> <maml:para>Specifications of Tier0 uplinks for the Edge Node. For edge cluster creation uplink network is mandatory otherwise its optional an field</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxTEdgeUplinkNetwork></command:parameterValue> <dev:type> <maml:name>List<NsxTEdgeUplinkNetwork></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FirstNsxVdsUplink</maml:name> <maml:Description> <maml:para>First NSX enabled VDS uplink for the Edge node</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SecondNsxVdsUplink</maml:name> <maml:Description> <maml:para>Second NSX enabled VDS uplink for the Edge node</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeNodeName</maml:name> <maml:Description> <maml:para>Edge Node Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ManagementIP</maml:name> <maml:Description> <maml:para>Management Interface IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ManagementGateway</maml:name> <maml:Description> <maml:para>Management Gateway IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmManagementPortgroupVlan</maml:name> <maml:Description> <maml:para>Management Vlan Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">uint?</command:parameterValue> <dev:type> <maml:name>uint?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmManagementPortgroupName</maml:name> <maml:Description> <maml:para>Management Network Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTepGateway</maml:name> <maml:Description> <maml:para>Edge TEP Gateway IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTep1IP</maml:name> <maml:Description> <maml:para>Edge TEP 1 IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTep2IP</maml:name> <maml:Description> <maml:para>Edge TEP 2 IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTepIpAddressPool</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EdgeTepIpAddressPoolSpec</command:parameterValue> <dev:type> <maml:name>EdgeTepIpAddressPoolSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EdgeTepVlan</maml:name> <maml:Description> <maml:para>Edge TEP VLAN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>ID of vSphere cluster where the Edge node will be deployed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InterRackCluster</maml:name> <maml:Description> <maml:para>Is inter-rack cluster(true for L2 non-uniform and L3 : At least one of management, uplink, Edge and host TEP networks is different for hosts of the cluster, false for L2 uniform : All hosts in cluster have identical management, uplink, Edge and host TEP networks)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkNetwork</maml:name> <maml:Description> <maml:para>Specifications of Tier0 uplinks for the Edge Node. For edge cluster creation uplink network is mandatory otherwise its optional an field</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxTEdgeUplinkNetwork></command:parameterValue> <dev:type> <maml:name>List<NsxTEdgeUplinkNetwork></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FirstNsxVdsUplink</maml:name> <maml:Description> <maml:para>First NSX enabled VDS uplink for the Edge node</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SecondNsxVdsUplink</maml:name> <maml:Description> <maml:para>Second NSX enabled VDS uplink for the Edge node</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $EdgeTepIpAddressPoolSpec = Initialize-VcfEdgeTepIpAddressPoolSpec -Name "MyName" -NsxId "MyNsxId" $BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" -PeerIP "MyPeerIP" -AsnPeer 0 -BgpPeerPassword "MyBgpPeerPassword" -BgpPeers $BgpPeerSpec $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -VmManagementPortgroupVlan 0 -VmManagementPortgroupName "MyVmManagementPortgroupName" -EdgeTepGateway "MyEdgeTepGateway" -EdgeTep1IP "MyEdgeTep1IP" -EdgeTep2IP "MyEdgeTep2IP" -EdgeTepIpAddressPool $EdgeTepIpAddressPoolSpec -EdgeTepVlan 0 -ClusterId "MyClusterId" -InterRackCluster $false -UplinkNetwork $NsxTEdgeUplinkNetwork -FirstNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" -SecondNsxVdsUplink "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTEdgeNodeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NsxTEdgeNodeSpec = Initialize-VcfNsxTEdgeNodeSpec -EdgeNodeName "MyEdgeNodeName" -ManagementIP "MyManagementIP" -ManagementGateway "MyManagementGateway" -EdgeTepVlan 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTEdgeNodeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxTEdgeNodeSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEdgeTepIpAddressPoolSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxTEdgeUplinkNetwork</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxTEdgeUplinkNetwork</command:noun> <maml:description> <maml:para>This specification contains input parameters required to configure uplink network for NSX edge node VM</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains input parameters required to configure uplink network for NSX edge node VM</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxTEdgeUplinkNetwork</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkVlan</maml:name> <maml:Description> <maml:para>Uplink Vlan</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkInterfaceIP</maml:name> <maml:Description> <maml:para>Uplink IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PeerIP</maml:name> <maml:Description> <maml:para>[Deprecated] BGP Peer IP (please use bgpPeers instead)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AsnPeer</maml:name> <maml:Description> <maml:para>[Deprecated] ASN of Peer (please use bgpPeers instead)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BgpPeerPassword</maml:name> <maml:Description> <maml:para>[Deprecated] BGP Peer Password (please use bgpPeers instead)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BgpPeers</maml:name> <maml:Description> <maml:para>List of BGP Peer configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BgpPeerSpec></command:parameterValue> <dev:type> <maml:name>List<BgpPeerSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkVlan</maml:name> <maml:Description> <maml:para>Uplink Vlan</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkInterfaceIP</maml:name> <maml:Description> <maml:para>Uplink IP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PeerIP</maml:name> <maml:Description> <maml:para>[Deprecated] BGP Peer IP (please use bgpPeers instead)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AsnPeer</maml:name> <maml:Description> <maml:para>[Deprecated] ASN of Peer (please use bgpPeers instead)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BgpPeerPassword</maml:name> <maml:Description> <maml:para>[Deprecated] BGP Peer Password (please use bgpPeers instead)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BgpPeers</maml:name> <maml:Description> <maml:para>List of BGP Peer configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BgpPeerSpec></command:parameterValue> <dev:type> <maml:name>List<BgpPeerSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BgpPeerSpec = Initialize-VcfBgpPeerSpec -Ip "MyIp" -Asn 0 -Password "MyPassword" $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" -PeerIP "MyPeerIP" -AsnPeer 0 -BgpPeerPassword "MyBgpPeerPassword" -BgpPeers $BgpPeerSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTEdgeUplinkNetwork with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NsxTEdgeUplinkNetwork = Initialize-VcfNsxTEdgeUplinkNetwork -UplinkVlan 0 -UplinkInterfaceIP "MyUplinkInterfaceIP" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTEdgeUplinkNetwork with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxTEdgeUplinkNetwork</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxtHostClusterUpgradeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxtHostClusterUpgradeSpec</command:noun> <maml:description> <maml:para>Host trnasport node cluster upgrade input</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Host trnasport node cluster upgrade input</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxtHostClusterUpgradeSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostClusterId</maml:name> <maml:Description> <maml:para>Resource ID of the host transport node cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostParallelUpgrade</maml:name> <maml:Description> <maml:para>Flag for disabling/enabling parallel upgrade within the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LiveUpgrade</maml:name> <maml:Description> <maml:para>Flag for disabling/enabling live upgrade of hosts in the transportnode clusters</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostClusterId</maml:name> <maml:Description> <maml:para>Resource ID of the host transport node cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostParallelUpgrade</maml:name> <maml:Description> <maml:para>Flag for disabling/enabling parallel upgrade within the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LiveUpgrade</maml:name> <maml:Description> <maml:para>Flag for disabling/enabling live upgrade of hosts in the transportnode clusters</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxtHostClusterUpgradeSpec = Initialize-VcfNsxtHostClusterUpgradeSpec -HostClusterId "MyHostClusterId" -HostParallelUpgrade $false -LiveUpgrade $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtHostClusterUpgradeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxtHostClusterUpgradeSpec = Initialize-VcfNsxtHostClusterUpgradeSpec -HostClusterId "MyHostClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtHostClusterUpgradeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxtHostClusterUpgradeSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxtHostSwitchConfig</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxtHostSwitchConfig</command:noun> <maml:description> <maml:para>This specification contains the configurations to be applied on the Host switch.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the configurations to be applied on the Host switch.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxtHostSwitchConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsName</maml:name> <maml:Description> <maml:para>The name of the vSphere Distributed Switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkProfileName</maml:name> <maml:Description> <maml:para>The name of the uplink profile</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolName</maml:name> <maml:Description> <maml:para>The IP address pool name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsUplinkToNsxUplink</maml:name> <maml:Description> <maml:para>The map of vSphere Distributed Switch uplinks to the NSX switch uplinks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<UplinkMapping></command:parameterValue> <dev:type> <maml:name>List<UplinkMapping></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsName</maml:name> <maml:Description> <maml:para>The name of the vSphere Distributed Switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UplinkProfileName</maml:name> <maml:Description> <maml:para>The name of the uplink profile</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolName</maml:name> <maml:Description> <maml:para>The IP address pool name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsUplinkToNsxUplink</maml:name> <maml:Description> <maml:para>The map of vSphere Distributed Switch uplinks to the NSX switch uplinks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<UplinkMapping></command:parameterValue> <dev:type> <maml:name>List<UplinkMapping></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtHostSwitchConfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -VdsUplinkToNsxUplink $UplinkMapping </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtHostSwitchConfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxtHostSwitchConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxtIpAddressPoolValidationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxtIpAddressPoolValidationSpec</command:noun> <maml:description> <maml:para>No description available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxtIpAddressPoolValidationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpAddressPoolSpec</command:parameterValue> <dev:type> <maml:name>IpAddressPoolSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtClusterId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpAddressPoolSpec</command:parameterValue> <dev:type> <maml:name>IpAddressPoolSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtClusterId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $NsxtIpAddressPoolValidationSpec = Initialize-VcfNsxtIpAddressPoolValidationSpec -IpAddressPoolSpec $IpAddressPoolSpec -NsxtClusterId "MyNsxtClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtIpAddressPoolValidationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" $NsxtIpAddressPoolValidationSpec = Initialize-VcfNsxtIpAddressPoolValidationSpec -IpAddressPoolSpec $IpAddressPoolSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtIpAddressPoolValidationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxtIpAddressPoolValidationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIpAddressPoolSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxtOidcSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxtOidcSpec</command:noun> <maml:description> <maml:para>Spec for the parameters required to add OpenId connection to NSX</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec for the parameters required to add OpenId connection to NSX</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxtOidcSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EntityInventoryId</maml:name> <maml:Description> <maml:para>VCF Inventory identificator of the entity to connect oidc</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OidcType</maml:name> <maml:Description> <maml:para>Type of the oidc entity.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(OidcTypeEnum)</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EntityInventoryId</maml:name> <maml:Description> <maml:para>VCF Inventory identificator of the entity to connect oidc</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OidcType</maml:name> <maml:Description> <maml:para>Type of the oidc entity.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(OidcTypeEnum)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxtOidcSpec = Initialize-VcfNsxtOidcSpec -EntityInventoryId "MyEntityInventoryId" -OidcType "vcenter" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtOidcSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxtOidcSpec = Initialize-VcfNsxtOidcSpec -EntityInventoryId "MyEntityInventoryId" -OidcType "vcenter" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtOidcSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxtOidcSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxTSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxTSpec</command:noun> <maml:description> <maml:para>This specification contains the parameters required to install and configure NSX in a workload domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the parameters required to install and configure NSX in a workload domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxTSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxManagerSpecs</maml:name> <maml:Description> <maml:para>Specification details of the NSX Manager virtual machine</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxManagerSpec></command:parameterValue> <dev:type> <maml:name>List<NsxManagerSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vip</maml:name> <maml:Description> <maml:para>Virtual IP address which would act as proxy/alias for NSX Managers. Can be omitted if FQDN is provided.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VipFqdn</maml:name> <maml:Description> <maml:para>FQDN for VIP so that common SSL certificates can be installed across all managers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>NSX license value</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxManagerAdminPassword</maml:name> <maml:Description> <maml:para>NSX manager admin password (basic auth and SSH)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxManagerAuditPassword</maml:name> <maml:Description> <maml:para>NSX manager Audit password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FormFactor</maml:name> <maml:Description> <maml:para>NSX manager form factor</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpAddressPoolSpec</command:parameterValue> <dev:type> <maml:name>IpAddressPoolSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxManagerSpecs</maml:name> <maml:Description> <maml:para>Specification details of the NSX Manager virtual machine</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxManagerSpec></command:parameterValue> <dev:type> <maml:name>List<NsxManagerSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vip</maml:name> <maml:Description> <maml:para>Virtual IP address which would act as proxy/alias for NSX Managers. Can be omitted if FQDN is provided.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VipFqdn</maml:name> <maml:Description> <maml:para>FQDN for VIP so that common SSL certificates can be installed across all managers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>NSX license value</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxManagerAdminPassword</maml:name> <maml:Description> <maml:para>NSX manager admin password (basic auth and SSH)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxManagerAuditPassword</maml:name> <maml:Description> <maml:para>NSX manager Audit password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FormFactor</maml:name> <maml:Description> <maml:para>NSX manager form factor</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddressPoolSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IpAddressPoolSpec</command:parameterValue> <dev:type> <maml:name>IpAddressPoolSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" $NsxManagerSpec = Initialize-VcfNsxManagerSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec $IpAddressPoolRangeSpec = Initialize-VcfIpAddressPoolRangeSpec -Start "MyStart" -End "MyEnd" $IpAddressPoolSubnetSpec = Initialize-VcfIpAddressPoolSubnetSpec -IpAddressPoolRanges $IpAddressPoolRangeSpec -Cidr "MyCidr" -Gateway "MyGateway" $IpAddressPoolSpec = Initialize-VcfIpAddressPoolSpec -Name "MyName" -Description "MyDescription" -IgnoreUnavailableNsxtCluster $false -Subnets $IpAddressPoolSubnetSpec $NsxTSpec = Initialize-VcfNsxTSpec -NsxManagerSpecs $NsxManagerSpec -Vip "MyVip" -VipFqdn "MyVipFqdn" -LicenseKey "MyLicenseKey" -NsxManagerAdminPassword "MyNsxManagerAdminPassword" -NsxManagerAuditPassword "MyNsxManagerAuditPassword" -FormFactor "MyFormFactor" -IpAddressPoolSpec $IpAddressPoolSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -DnsName "MyDnsName" $NsxManagerSpec = Initialize-VcfNsxManagerSpec -NetworkDetailsSpec $NetworkDetailsSpec $NsxTSpec = Initialize-VcfNsxTSpec -NsxManagerSpecs $NsxManagerSpec -VipFqdn "MyVipFqdn" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxTSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxTSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfIpAddressPoolSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxtSwitchConfig</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxtSwitchConfig</command:noun> <maml:description> <maml:para>This specification contains the configurations to be associated with the vSphere Distributed Switch managed by NSX</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the configurations to be associated with the vSphere Distributed Switch managed by NSX</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxtSwitchConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransportZones</maml:name> <maml:Description> <maml:para>The list of transport zones to be associated with the vSphere Distributed Switch managed by NSX</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<TransportZone></command:parameterValue> <dev:type> <maml:name>List<TransportZone></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostSwitchOperationalMode</maml:name> <maml:Description> <maml:para>Operational mode type of a Host Switch. Applicable only for the VI Workload Domains.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransportZones</maml:name> <maml:Description> <maml:para>The list of transport zones to be associated with the vSphere Distributed Switch managed by NSX</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<TransportZone></command:parameterValue> <dev:type> <maml:name>List<TransportZone></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostSwitchOperationalMode</maml:name> <maml:Description> <maml:para>Operational mode type of a Host Switch. Applicable only for the VI Workload Domains.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtSwitchConfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $TransportZone = Initialize-VcfTransportZone -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtSwitchConfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxtSwitchConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxtUpgradeOptions</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxtUpgradeOptions</command:noun> <maml:description> <maml:para>NSX Upgrade options</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NSX Upgrade options</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxtUpgradeOptions</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsEdgeOnlyUpgrade</maml:name> <maml:Description> <maml:para>Flag for performing edge-only upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsHostClustersUpgradeParallel</maml:name> <maml:Description> <maml:para>Flag for disabling/enabling parallel upgrade of host transportnode clusters</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsEdgeClustersUpgradeParallel</maml:name> <maml:Description> <maml:para>Flag for disabling/enabling parallel upgrade of edge transportnode clusters</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsEdgeOnlyUpgrade</maml:name> <maml:Description> <maml:para>Flag for performing edge-only upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsHostClustersUpgradeParallel</maml:name> <maml:Description> <maml:para>Flag for disabling/enabling parallel upgrade of host transportnode clusters</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsEdgeClustersUpgradeParallel</maml:name> <maml:Description> <maml:para>Flag for disabling/enabling parallel upgrade of edge transportnode clusters</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NsxtUpgradeOptions = Initialize-VcfNsxtUpgradeOptions -IsEdgeOnlyUpgrade $false -IsHostClustersUpgradeParallel $false -IsEdgeClustersUpgradeParallel $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtUpgradeOptions with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NsxtUpgradeOptions = Initialize-VcfNsxtUpgradeOptions </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtUpgradeOptions with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxtUpgradeOptions</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNsxtUpgradeUserInputSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>NsxtUpgradeUserInputSpec</command:noun> <maml:description> <maml:para>NSX Upgrade User Input Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NSX Upgrade User Input Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNsxtUpgradeUserInputSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtHostClusterUpgradeSpecs</maml:name> <maml:Description> <maml:para>List of host clusters information if explicit selection is to be made</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtHostClusterUpgradeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxtHostClusterUpgradeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtEdgeClusterUpgradeSpecs</maml:name> <maml:Description> <maml:para>List of edge clusters information if explicit selection is to be made</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtEdgeClusterUpgradeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxtEdgeClusterUpgradeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtUpgradeOptions</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxtUpgradeOptions</command:parameterValue> <dev:type> <maml:name>NsxtUpgradeOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtId</maml:name> <maml:Description> <maml:para>Identifier of the NSX instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtHostClusterUpgradeSpecs</maml:name> <maml:Description> <maml:para>List of host clusters information if explicit selection is to be made</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtHostClusterUpgradeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxtHostClusterUpgradeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtEdgeClusterUpgradeSpecs</maml:name> <maml:Description> <maml:para>List of edge clusters information if explicit selection is to be made</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtEdgeClusterUpgradeSpec></command:parameterValue> <dev:type> <maml:name>List<NsxtEdgeClusterUpgradeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtUpgradeOptions</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxtUpgradeOptions</command:parameterValue> <dev:type> <maml:name>NsxtUpgradeOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtId</maml:name> <maml:Description> <maml:para>Identifier of the NSX instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NsxtHostClusterUpgradeSpec = Initialize-VcfNsxtHostClusterUpgradeSpec -HostClusterId "MyHostClusterId" -HostParallelUpgrade $false -LiveUpgrade $false $NsxtEdgeClusterUpgradeSpec = Initialize-VcfNsxtEdgeClusterUpgradeSpec -EdgeClusterId "MyEdgeClusterId" -EdgeParallelUpgrade $false $NsxtUpgradeOptions = Initialize-VcfNsxtUpgradeOptions -IsEdgeOnlyUpgrade $false -IsHostClustersUpgradeParallel $false -IsEdgeClustersUpgradeParallel $false $NsxtUpgradeUserInputSpec = Initialize-VcfNsxtUpgradeUserInputSpec -NsxtHostClusterUpgradeSpecs $NsxtHostClusterUpgradeSpec -NsxtEdgeClusterUpgradeSpecs $NsxtEdgeClusterUpgradeSpec -NsxtUpgradeOptions $NsxtUpgradeOptions -NsxtId "MyNsxtId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtUpgradeUserInputSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NsxtUpgradeUserInputSpec = Initialize-VcfNsxtUpgradeUserInputSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNsxtUpgradeUserInputSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NsxtUpgradeUserInputSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxtUpgradeOptions</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNtpConfiguration</command:name> <command:verb>Initialize</command:verb> <command:noun>NtpConfiguration</command:noun> <maml:description> <maml:para>NTP Configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NTP Configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNtpConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NtpServers</maml:name> <maml:Description> <maml:para>List of NTP servers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NtpServer></command:parameterValue> <dev:type> <maml:name>List<NtpServer></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NtpServers</maml:name> <maml:Description> <maml:para>List of NTP servers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NtpServer></command:parameterValue> <dev:type> <maml:name>List<NtpServer></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NtpServer = Initialize-VcfNtpServer -IpAddress "10.0.0.250" $NtpConfiguration = Initialize-VcfNtpConfiguration -NtpServers $NtpServer </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNtpConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NtpServer = Initialize-VcfNtpServer -IpAddress "10.0.0.250" $NtpConfiguration = Initialize-VcfNtpConfiguration -NtpServers $NtpServer </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNtpConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NtpConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfNtpServer</command:name> <command:verb>Initialize</command:verb> <command:noun>NtpServer</command:noun> <maml:description> <maml:para>NTP server details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NTP server details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfNtpServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP address/FQDN of NTP server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP address/FQDN of NTP server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NtpServer = Initialize-VcfNtpServer -IpAddress "10.0.0.250" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNtpServer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NtpServer = Initialize-VcfNtpServer -IpAddress "10.0.0.250" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfNtpServer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/NtpServer</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOidcSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>OidcSpec</command:noun> <maml:description> <maml:para>Identity management configuration when the Identity Provider is based on oidc</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Identity management configuration when the Identity Provider is based on oidc</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOidcSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClientId</maml:name> <maml:Description> <maml:para>Client identifier to connect to the provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClientSecret</maml:name> <maml:Description> <maml:para>The secret shared between the client and the provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DiscoveryEndpoint</maml:name> <maml:Description> <maml:para>Endpoint to retrieve the provider metadata</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClientId</maml:name> <maml:Description> <maml:para>Client identifier to connect to the provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClientSecret</maml:name> <maml:Description> <maml:para>The secret shared between the client and the provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DiscoveryEndpoint</maml:name> <maml:Description> <maml:para>Endpoint to retrieve the provider metadata</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$OidcSpec = Initialize-VcfOidcSpec -ClientId "MyClientId" -ClientSecret "MyClientSecret" -DiscoveryEndpoint "MyDiscoveryEndpoint" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOidcSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OidcSpec = Initialize-VcfOidcSpec -ClientId "MyClientId" -ClientSecret "MyClientSecret" -DiscoveryEndpoint "MyDiscoveryEndpoint" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOidcSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/OidcSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpenSSLCertificateAuthoritySpec</command:name> <command:verb>Initialize</command:verb> <command:noun>OpenSSLCertificateAuthoritySpec</command:noun> <maml:description> <maml:para>This specification contains OpenSSL CA configuration details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains OpenSSL CA configuration details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpenSSLCertificateAuthoritySpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CommonName</maml:name> <maml:Description> <maml:para>OpenSSL CA domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Country</maml:name> <maml:Description> <maml:para>ISO 3166 country code where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>The full name of the state where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Locality</maml:name> <maml:Description> <maml:para>The city or locality where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Organization</maml:name> <maml:Description> <maml:para>The name under which company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrganizationUnit</maml:name> <maml:Description> <maml:para>Organization with which the certificate is associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CommonName</maml:name> <maml:Description> <maml:para>OpenSSL CA domain name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Country</maml:name> <maml:Description> <maml:para>ISO 3166 country code where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>State</maml:name> <maml:Description> <maml:para>The full name of the state where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Locality</maml:name> <maml:Description> <maml:para>The city or locality where company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Organization</maml:name> <maml:Description> <maml:para>The name under which company is legally registered</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrganizationUnit</maml:name> <maml:Description> <maml:para>Organization with which the certificate is associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$OpenSSLCertificateAuthoritySpec = Initialize-VcfOpenSSLCertificateAuthoritySpec -CommonName "OpenSSL CA" -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpenSSLCertificateAuthoritySpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OpenSSLCertificateAuthoritySpec = Initialize-VcfOpenSSLCertificateAuthoritySpec -CommonName "OpenSSL CA" -Country "IN" -State "Karnataka" -Locality "Bengaluru" -Organization "VMware Inc." -OrganizationUnit "VCF" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpenSSLCertificateAuthoritySpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/OpenSSLCertificateAuthoritySpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfConnectVrliWithDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfConnectVrliWithDomain</command:noun> <maml:description> <maml:para>No summary available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Connect or disconnect a domain with VMware Aria Operations for Logs</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfConnectVrliWithDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIntegration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainIntegration</command:parameterValue> <dev:type> <maml:name>DomainIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIntegration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainIntegration</command:parameterValue> <dev:type> <maml:name>DomainIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DomainIntegration = Initialize-VcfDomainIntegration -DomainId "MyDomainId" -Status "ENABLED" Invoke-VcfConnectVrliWithDomain -domainIntegration $domainIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConnectVrliWithDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DomainIntegration = Initialize-VcfDomainIntegration -DomainId "MyDomainId" -Status "ENABLED" Invoke-VcfConnectVrliWithDomain -domainIntegration $domainIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConnectVrliWithDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrli/domains/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDomainIntegration</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVrliIntegratedDomains</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVrliIntegratedDomains</command:noun> <maml:description> <maml:para>Retrieve a list of VMware Aria Operations for Logs integration status for domains</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVrliIntegratedDomains</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfDomainIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrliIntegratedDomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrliIntegratedDomains with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrliIntegratedDomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrliIntegratedDomains with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrli/domains/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVrlis</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVrlis</command:noun> <maml:description> <maml:para>Retrieve a list of VMware Aria Operations for Logs instances</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVrlis</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVrli</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrlis </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrlis with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrlis </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrlis with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrlis/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfConnectVropsWithDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfConnectVropsWithDomain</command:noun> <maml:description> <maml:para>Connect or disconnect a domain with VMware Aria Operations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Connects/disconnects a workload domains with VMware Aria Operations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfConnectVropsWithDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIntegration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainIntegration</command:parameterValue> <dev:type> <maml:name>DomainIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainIntegration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainIntegration</command:parameterValue> <dev:type> <maml:name>DomainIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DomainIntegration = Initialize-VcfDomainIntegration -DomainId "MyDomainId" -Status "ENABLED" Invoke-VcfConnectVropsWithDomain -domainIntegration $domainIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConnectVropsWithDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DomainIntegration = Initialize-VcfDomainIntegration -DomainId "MyDomainId" -Status "ENABLED" Invoke-VcfConnectVropsWithDomain -domainIntegration $domainIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConnectVropsWithDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrops/domains/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDomainIntegration</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVropsIntegratedDomains</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVropsIntegratedDomains</command:noun> <maml:description> <maml:para>Retrieve a list of VMware Aria Operations integration status for domains</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves the existing domains and their connection status with Aria Operations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVropsIntegratedDomains</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfDomainIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVropsIntegratedDomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVropsIntegratedDomains with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVropsIntegratedDomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVropsIntegratedDomains with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrops/domains/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVropses</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVropses</command:noun> <maml:description> <maml:para>Retrieve a list of VMware Aria Operations instances</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVropses</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVrops</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVropses </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVropses with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVropses </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVropses with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vropses/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPackageSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>PackageSpec</command:noun> <maml:description> <maml:para>Hardware Support Package Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hardware Support Package Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPackageSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Package version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Package version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PackageSpec = Initialize-VcfPackageSpec -Name "MyName" -_Version "My_Version" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPackageSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PackageSpec = Initialize-VcfPackageSpec -Name "MyName" -_Version "My_Version" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPackageSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PackageSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPageOfSddcTask</command:name> <command:verb>Initialize</command:verb> <command:noun>PageOfSddcTask</command:noun> <maml:description> <maml:para>No description available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPageOfSddcTask</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>The list of elements included in this page</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SddcTask></command:parameterValue> <dev:type> <maml:name>List<SddcTask></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageMetadata</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PageMetadata</command:parameterValue> <dev:type> <maml:name>PageMetadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>The list of elements included in this page</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SddcTask></command:parameterValue> <dev:type> <maml:name>List<SddcTask></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageMetadata</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PageMetadata</command:parameterValue> <dev:type> <maml:name>PageMetadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $SddcSubTask = Initialize-VcfSddcSubTask -SddcId "123e4567-e89b-42d3-a456-556642440000" -ProcessingStateName "MyProcessingStateName" -ProcessingStateDescription "MyProcessingStateDescription" -Name "MyName" -Description "MyDescription" -LocalizableNamePack $MessagePack -LocalizableDescriptionPack $MessagePack -Status "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR" -CreationTimestamp "MyCreationTimestamp" -UpdateTimestamp "MyUpdateTimestamp" -Errors $Error $SddcTask = Initialize-VcfSddcTask -Id "MyId" -Name "MyName" -Status "COMPLETED_WITH_SUCCESS" -LocalizableNamePack $MessagePack -CreationTimestamp "MyCreationTimestamp" -SddcSubTasks $SddcSubTask $PageOfSddcTask = Initialize-VcfPageOfSddcTask -Elements $SddcTask -PageMetadata $PageMetadata </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPageOfSddcTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PageOfSddcTask = Initialize-VcfPageOfSddcTask </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPageOfSddcTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PageOfSddcTask</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-Vcf</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPageOfValidation</command:name> <command:verb>Initialize</command:verb> <command:noun>PageOfValidation</command:noun> <maml:description> <maml:para>No description available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPageOfValidation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>The list of elements included in this page</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Validation></command:parameterValue> <dev:type> <maml:name>List<Validation></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageMetadata</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PageMetadata</command:parameterValue> <dev:type> <maml:name>PageMetadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>The list of elements included in this page</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Validation></command:parameterValue> <dev:type> <maml:name>List<Validation></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageMetadata</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PageMetadata</command:parameterValue> <dev:type> <maml:name>PageMetadata</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PageOfValidation = Initialize-VcfPageOfValidation -Elements $Validation -PageMetadata $PageMetadata </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPageOfValidation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PageOfValidation = Initialize-VcfPageOfValidation </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPageOfValidation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PageOfValidation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-Vcf</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPartnerExtensionSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>PartnerExtensionSpec</command:noun> <maml:description> <maml:para>Specification for partner extensions. This specification is used in the Bundle Upload API</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Specification for partner extensions. This specification is used in the Bundle Upload API</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPartnerExtensionSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PartnerBundleVersion</maml:name> <maml:Description> <maml:para>Version of partner bundle to be uploaded. Should match one of the bundle versions available in the partner bundle metadata file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PartnerBundleMetadataFilePath</maml:name> <maml:Description> <maml:para>Path to the bundle metadata file. The metadata file can have details of multiple bundles</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PartnerBundleVersion</maml:name> <maml:Description> <maml:para>Version of partner bundle to be uploaded. Should match one of the bundle versions available in the partner bundle metadata file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PartnerBundleMetadataFilePath</maml:name> <maml:Description> <maml:para>Path to the bundle metadata file. The metadata file can have details of multiple bundles</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PartnerExtensionSpec = Initialize-VcfPartnerExtensionSpec -PartnerBundleVersion "MyPartnerBundleVersion" -PartnerBundleMetadataFilePath "MyPartnerBundleMetadataFilePath" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPartnerExtensionSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PartnerExtensionSpec = Initialize-VcfPartnerExtensionSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPartnerExtensionSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PartnerExtensionSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPatch</command:name> <command:verb>Initialize</command:verb> <command:noun>Patch</command:noun> <maml:description> <maml:para>Patch rest model that is located in the Product Version Catalog, these models are consumed by LCM's Flex BOM workflows.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Patch rest model that is located in the Product Version Catalog, these models are consumed by LCM's Flex BOM workflows.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPatch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersion</maml:name> <maml:Description> <maml:para>Product version of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Artifacts</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Artifact</command:parameterValue> <dev:type> <maml:name>Artifact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersion</maml:name> <maml:Description> <maml:para>Product version of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Artifacts</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Artifact</command:parameterValue> <dev:type> <maml:name>Artifact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BundleInfo = Initialize-VcfBundleInfo -Id "MyId" -Type "MyType" -Name "MyName" $Artifact = Initialize-VcfArtifact -Bundles $BundleInfo $Patch = Initialize-VcfPatch -ProductVersion "MyProductVersion" -Artifacts $Artifact </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPatch with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Artifact = Initialize-VcfArtifact $Patch = Initialize-VcfPatch -ProductVersion "MyProductVersion" -Artifacts $Artifact </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPatch with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Patch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfArtifact</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPatchBundle</command:name> <command:verb>Initialize</command:verb> <command:noun>PatchBundle</command:noun> <maml:description> <maml:para>Model for patch bundle in a release</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model for patch bundle in a release</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPatchBundle</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>Bundle ID of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleType</maml:name> <maml:Description> <maml:para>Bundle type of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleElements</maml:name> <maml:Description> <maml:para>Bundle elements of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CumulativeFromVcfVersion</maml:name> <maml:Description> <maml:para>Minimum VCF version that this patch bundle can be directly applied on</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>Bundle ID of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleType</maml:name> <maml:Description> <maml:para>Bundle type of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleElements</maml:name> <maml:Description> <maml:para>Bundle elements of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CumulativeFromVcfVersion</maml:name> <maml:Description> <maml:para>Minimum VCF version that this patch bundle can be directly applied on</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PatchBundle = Initialize-VcfPatchBundle -BundleId "MyBundleId" -BundleType "MyBundleType" -BundleElements "MyBundleElements" -CumulativeFromVcfVersion "MyCumulativeFromVcfVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPatchBundle with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PatchBundle = Initialize-VcfPatchBundle -BundleId "MyBundleId" -BundleType "MyBundleType" -BundleElements "MyBundleElements" -CumulativeFromVcfVersion "MyCumulativeFromVcfVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPatchBundle with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PatchBundle</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeletePersonality</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeletePersonality</command:noun> <maml:description> <maml:para>Delete the personality based on either name or id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete the personality based on either name or id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeletePersonality</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>The personality id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityName</maml:name> <maml:Description> <maml:para>The personality name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>The personality id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityName</maml:name> <maml:Description> <maml:para>The personality name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeletePersonality -personalityId "MypersonalityId" -personalityName "MypersonalityName" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeletePersonality with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeletePersonality </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeletePersonality with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/personalities/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetPersonalities</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetPersonalities</command:noun> <maml:description> <maml:para>Get the Personalities</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Personalities which are available via depot access.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetPersonalities</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseOSVersion</maml:name> <maml:Description> <maml:para>The base OS version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AddOnName</maml:name> <maml:Description> <maml:para>The add on name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AddOnVendorName</maml:name> <maml:Description> <maml:para>The add on vendor name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComponentName</maml:name> <maml:Description> <maml:para>The component name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComponentVendorName</maml:name> <maml:Description> <maml:para>The component vendor name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityName</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseOSVersion</maml:name> <maml:Description> <maml:para>The base OS version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AddOnName</maml:name> <maml:Description> <maml:para>The add on name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AddOnVendorName</maml:name> <maml:Description> <maml:para>The add on vendor name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComponentName</maml:name> <maml:Description> <maml:para>The component name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ComponentVendorName</maml:name> <maml:Description> <maml:para>The component vendor name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityName</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfPersonality</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetPersonalities -baseOSVersion 7.0.0-0.0.30340198 -addOnName "MyaddOnName" -addOnVendorName "MyaddOnVendorName" -componentName "MycomponentName" -componentVendorName "MycomponentVendorName" -personalityName "MypersonalityName" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPersonalities with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetPersonalities </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPersonalities with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/personalities/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetPersonality</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetPersonality</command:noun> <maml:description> <maml:para>Get a Personality by its id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Personality for id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetPersonality</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>Personality ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>Personality ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Personality</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetPersonality -personalityId "MypersonalityId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPersonality with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetPersonality -personalityId "MypersonalityId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPersonality with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/personalities/personalityid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRenamePersonalityById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRenamePersonalityById</command:noun> <maml:description> <maml:para>Rename personality based on ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Rename personality with the ID passed in the URL</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRenamePersonalityById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>The personality id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Personality</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Personality</command:parameterValue> <dev:type> <maml:name>Personality</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>The personality id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Personality</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Personality</command:parameterValue> <dev:type> <maml:name>Personality</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Personality</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ModelVersion = Initialize-VcfModelVersion -_Version "8.0.3-0.0.23174786" -DisplayVersion "8.0 Update 3 - 23174786" $BaseImageDetails = Initialize-VcfBaseImageDetails -DisplayName "7.0.0-0.0.30340198" -DisplayVersion "MyDisplayVersion" -ReleaseDate "MyReleaseDate" -ReleaseTimestamp "MyReleaseTimestamp" -QuickPatchCompatibleVersions $ModelVersion $BaseImageInfo = Initialize-VcfBaseImageInfo -_Version "7.0.0-0.0.30340198" -Details $BaseImageDetails $AddOnInfo = Initialize-VcfAddOnInfo -_Version "2.0-1" -Name "DELL-sample-Addon" -Vendor "Dell" -DisplayName "MyDisplayName" -DisplayVersion "MyDisplayVersion" $ComponentDetails = Initialize-VcfComponentDetails -Vendor "intel" -DisplayName "MyDisplayName" -DisplayVersion "MyDisplayVersion" $ComponentInfo = Initialize-VcfComponentInfo -_Version "1.3.2.8-1OEM.650.0.0.4598673" -Details $ComponentDetails $HardwareSupportPackageInfo = Initialize-VcfHardwareSupportPackageInfo -Pkg "MyPkg" -_Version "My_Version" $HardwareSupportInfo = Initialize-VcfHardwareSupportInfo -Packages @{ key_example = $HardwareSupportPackageInfo } $SoftwareInfo = Initialize-VcfSoftwareInfo -BaseImage $BaseImageInfo -AddOn $AddOnInfo -Components @{ key_example = $ComponentInfo } -HardwareSupport $HardwareSupportInfo $Personality = Initialize-VcfPersonality -_Version "My_Version" -PersonalityId "MyPersonalityId" -PersonalityName "MyPersonalityName" -Description "ESXi 7.0 Dell Personality" -CreatedBy "MyCreatedBy" -ImageSize "MyImageSize" -ImageChecksum "MyImageChecksum" -VsphereExportedZipPath "MyVsphereExportedZipPath" -VsphereExportedIsoPath "MyVsphereExportedIsoPath" -VsphereExportedJsonPath "MyVsphereExportedJsonPath" -DisplayName "ESXi 7.0 Dell Personality" -ReleaseDate "MyReleaseDate" -ImportTimestamp "MyImportTimestamp" -Tags "MyTags" -KbArticles "MyKbArticles" -SoftwareInfo $SoftwareInfo Invoke-VcfRenamePersonalityById -personalityId "MypersonalityId" -personality $personality </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRenamePersonalityById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BaseImageInfo = Initialize-VcfBaseImageInfo -_Version "7.0.0-0.0.30340198" $SoftwareInfo = Initialize-VcfSoftwareInfo -BaseImage $BaseImageInfo $Personality = Initialize-VcfPersonality -_Version "My_Version" -PersonalityId "MyPersonalityId" -PersonalityName "MyPersonalityName" -Description "ESXi 7.0 Dell Personality" -ImageSize "MyImageSize" -ImageChecksum "MyImageChecksum" -VsphereExportedZipPath "MyVsphereExportedZipPath" -VsphereExportedIsoPath "MyVsphereExportedIsoPath" -VsphereExportedJsonPath "MyVsphereExportedJsonPath" -DisplayName "ESXi 7.0 Dell Personality" -SoftwareInfo $SoftwareInfo Invoke-VcfRenamePersonalityById -personalityId "MypersonalityId" -personality $personality </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRenamePersonalityById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/personalities/personalityid/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfPersonality</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUploadPersonality</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUploadPersonality</command:noun> <maml:description> <maml:para>Upload a Personality</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upload Personality to SDDC Manager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUploadPersonality</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityUploadSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalityUploadSpec</command:parameterValue> <dev:type> <maml:name>PersonalityUploadSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityUploadSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalityUploadSpec</command:parameterValue> <dev:type> <maml:name>PersonalityUploadSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PersonalityUploadSpecRaw = Initialize-VcfPersonalityUploadSpecRaw -PersonalityInfoJSONFilePath "MyPersonalityInfoJSONFilePath" -PersonalityJSONFilePath "MyPersonalityJSONFilePath" -PersonalityZIPFilePath "MyPersonalityZIPFilePath" -PersonalityISOFilePath "MyPersonalityISOFilePath" $PersonalityUploadSpecRawWithFileUploadId = Initialize-VcfPersonalityUploadSpecRawWithFileUploadId -FileUploadId "MyFileUploadId" $PersonalityUploadSpecReferred = Initialize-VcfPersonalityUploadSpecReferred -VCenterId "MyVCenterId" -ClusterId "MyClusterId" $PersonalityUploadSpec = Initialize-VcfPersonalityUploadSpec -UploadMode "One among: RAW, RAW_WITH_FILE_UPLOAD_ID, REFERRED" -UploadSpecRawMode $PersonalityUploadSpecRaw -UploadSpecRawWithFileUploadIdMode $PersonalityUploadSpecRawWithFileUploadId -UploadSpecReferredMode $PersonalityUploadSpecReferred -Name "MyName" Invoke-VcfUploadPersonality -personalityUploadSpec $personalityUploadSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadPersonality with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PersonalityUploadSpec = Initialize-VcfPersonalityUploadSpec -UploadMode "One among: RAW, RAW_WITH_FILE_UPLOAD_ID, REFERRED" Invoke-VcfUploadPersonality -personalityUploadSpec $personalityUploadSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadPersonality with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/personalities/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfPersonalityUploadSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUploadPersonalityFiles</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUploadPersonalityFiles</command:noun> <maml:description> <maml:para>Upload personality files to SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upload personality files to SDDC Manager</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUploadPersonalityFiles</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Files</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<FileParameter></command:parameterValue> <dev:type> <maml:name>List<FileParameter></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Files</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<FileParameter></command:parameterValue> <dev:type> <maml:name>List<FileParameter></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>string</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfUploadPersonalityFiles -files </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadPersonalityFiles with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfUploadPersonalityFiles -files </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadPersonalityFiles with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/personalities/files/put/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPersonality</command:name> <command:verb>Initialize</command:verb> <command:noun>Personality</command:noun> <maml:description> <maml:para>Personality contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Personality contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPersonality</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Personality Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>Personality id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityName</maml:name> <maml:Description> <maml:para>Personality name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Personality description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreatedBy</maml:name> <maml:Description> <maml:para>Personality created by</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ImageSize</maml:name> <maml:Description> <maml:para>Personality image size</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ImageChecksum</maml:name> <maml:Description> <maml:para>Personality image checksum</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsphereExportedZipPath</maml:name> <maml:Description> <maml:para>Personality depot path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsphereExportedIsoPath</maml:name> <maml:Description> <maml:para>Personality depot path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsphereExportedJsonPath</maml:name> <maml:Description> <maml:para>Personality depot path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>Personality displayName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>Personality Release date</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ImportTimestamp</maml:name> <maml:Description> <maml:para>Timestamp of Personality import into SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>Personality tags</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>KbArticles</maml:name> <maml:Description> <maml:para>Personality kb articles</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SoftwareInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SoftwareInfo</command:parameterValue> <dev:type> <maml:name>SoftwareInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Personality Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>Personality id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityName</maml:name> <maml:Description> <maml:para>Personality name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Personality description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreatedBy</maml:name> <maml:Description> <maml:para>Personality created by</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ImageSize</maml:name> <maml:Description> <maml:para>Personality image size</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ImageChecksum</maml:name> <maml:Description> <maml:para>Personality image checksum</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsphereExportedZipPath</maml:name> <maml:Description> <maml:para>Personality depot path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsphereExportedIsoPath</maml:name> <maml:Description> <maml:para>Personality depot path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsphereExportedJsonPath</maml:name> <maml:Description> <maml:para>Personality depot path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>Personality displayName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>Personality Release date</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ImportTimestamp</maml:name> <maml:Description> <maml:para>Timestamp of Personality import into SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Tags</maml:name> <maml:Description> <maml:para>Personality tags</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>KbArticles</maml:name> <maml:Description> <maml:para>Personality kb articles</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SoftwareInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SoftwareInfo</command:parameterValue> <dev:type> <maml:name>SoftwareInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ModelVersion = Initialize-VcfModelVersion -_Version "8.0.3-0.0.23174786" -DisplayVersion "8.0 Update 3 - 23174786" $BaseImageDetails = Initialize-VcfBaseImageDetails -DisplayName "7.0.0-0.0.30340198" -DisplayVersion "MyDisplayVersion" -ReleaseDate "MyReleaseDate" -ReleaseTimestamp "MyReleaseTimestamp" -QuickPatchCompatibleVersions $ModelVersion $BaseImageInfo = Initialize-VcfBaseImageInfo -_Version "7.0.0-0.0.30340198" -Details $BaseImageDetails $AddOnInfo = Initialize-VcfAddOnInfo -_Version "2.0-1" -Name "DELL-sample-Addon" -Vendor "Dell" -DisplayName "MyDisplayName" -DisplayVersion "MyDisplayVersion" $ComponentDetails = Initialize-VcfComponentDetails -Vendor "intel" -DisplayName "MyDisplayName" -DisplayVersion "MyDisplayVersion" $ComponentInfo = Initialize-VcfComponentInfo -_Version "1.3.2.8-1OEM.650.0.0.4598673" -Details $ComponentDetails $HardwareSupportPackageInfo = Initialize-VcfHardwareSupportPackageInfo -Pkg "MyPkg" -_Version "My_Version" $HardwareSupportInfo = Initialize-VcfHardwareSupportInfo -Packages @{ key_example = $HardwareSupportPackageInfo } $SoftwareInfo = Initialize-VcfSoftwareInfo -BaseImage $BaseImageInfo -AddOn $AddOnInfo -Components @{ key_example = $ComponentInfo } -HardwareSupport $HardwareSupportInfo $Personality = Initialize-VcfPersonality -_Version "My_Version" -PersonalityId "MyPersonalityId" -PersonalityName "MyPersonalityName" -Description "ESXi 7.0 Dell Personality" -CreatedBy "MyCreatedBy" -ImageSize "MyImageSize" -ImageChecksum "MyImageChecksum" -VsphereExportedZipPath "MyVsphereExportedZipPath" -VsphereExportedIsoPath "MyVsphereExportedIsoPath" -VsphereExportedJsonPath "MyVsphereExportedJsonPath" -DisplayName "ESXi 7.0 Dell Personality" -ReleaseDate "MyReleaseDate" -ImportTimestamp "MyImportTimestamp" -Tags "MyTags" -KbArticles "MyKbArticles" -SoftwareInfo $SoftwareInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonality with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BaseImageInfo = Initialize-VcfBaseImageInfo -_Version "7.0.0-0.0.30340198" $SoftwareInfo = Initialize-VcfSoftwareInfo -BaseImage $BaseImageInfo $Personality = Initialize-VcfPersonality -_Version "My_Version" -PersonalityId "MyPersonalityId" -PersonalityName "MyPersonalityName" -Description "ESXi 7.0 Dell Personality" -ImageSize "MyImageSize" -ImageChecksum "MyImageChecksum" -VsphereExportedZipPath "MyVsphereExportedZipPath" -VsphereExportedIsoPath "MyVsphereExportedIsoPath" -VsphereExportedJsonPath "MyVsphereExportedJsonPath" -DisplayName "ESXi 7.0 Dell Personality" -SoftwareInfo $SoftwareInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonality with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Personality</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSoftwareInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPersonalitySpec</command:name> <command:verb>Initialize</command:verb> <command:noun>PersonalitySpec</command:noun> <maml:description> <maml:para>Personality Specification for vLCM based upgrade</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Personality Specification for vLCM based upgrade</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPersonalitySpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>Personality ID for vLCM based Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HardwareSupportSpecs</maml:name> <maml:Description> <maml:para>Hardware Support Specifications for Firmware upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HardwareSupportSpec></command:parameterValue> <dev:type> <maml:name>List<HardwareSupportSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityId</maml:name> <maml:Description> <maml:para>Personality ID for vLCM based Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HardwareSupportSpecs</maml:name> <maml:Description> <maml:para>Hardware Support Specifications for Firmware upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HardwareSupportSpec></command:parameterValue> <dev:type> <maml:name>List<HardwareSupportSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PackageSpec = Initialize-VcfPackageSpec -Name "MyName" -_Version "My_Version" $HardwareSupportSpec = Initialize-VcfHardwareSupportSpec -Name "MyName" -PackageSpec $PackageSpec $PersonalitySpec = Initialize-VcfPersonalitySpec -PersonalityId "MyPersonalityId" -HardwareSupportSpecs $HardwareSupportSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalitySpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PersonalitySpec = Initialize-VcfPersonalitySpec -PersonalityId "MyPersonalityId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalitySpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PersonalitySpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPersonalityUploadSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>PersonalityUploadSpec</command:noun> <maml:description> <maml:para>Personality Upload Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Personality Upload Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPersonalityUploadSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UploadMode</maml:name> <maml:Description> <maml:para>Personality upload mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UploadSpecRawMode</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalityUploadSpecRaw</command:parameterValue> <dev:type> <maml:name>PersonalityUploadSpecRaw</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UploadSpecRawWithFileUploadIdMode</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalityUploadSpecRawWithFileUploadId</command:parameterValue> <dev:type> <maml:name>PersonalityUploadSpecRawWithFileUploadId</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UploadSpecReferredMode</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalityUploadSpecReferred</command:parameterValue> <dev:type> <maml:name>PersonalityUploadSpecReferred</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Personality name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UploadMode</maml:name> <maml:Description> <maml:para>Personality upload mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UploadSpecRawMode</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalityUploadSpecRaw</command:parameterValue> <dev:type> <maml:name>PersonalityUploadSpecRaw</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UploadSpecRawWithFileUploadIdMode</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalityUploadSpecRawWithFileUploadId</command:parameterValue> <dev:type> <maml:name>PersonalityUploadSpecRawWithFileUploadId</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UploadSpecReferredMode</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalityUploadSpecReferred</command:parameterValue> <dev:type> <maml:name>PersonalityUploadSpecReferred</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Personality name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PersonalityUploadSpecRaw = Initialize-VcfPersonalityUploadSpecRaw -PersonalityInfoJSONFilePath "MyPersonalityInfoJSONFilePath" -PersonalityJSONFilePath "MyPersonalityJSONFilePath" -PersonalityZIPFilePath "MyPersonalityZIPFilePath" -PersonalityISOFilePath "MyPersonalityISOFilePath" $PersonalityUploadSpecRawWithFileUploadId = Initialize-VcfPersonalityUploadSpecRawWithFileUploadId -FileUploadId "MyFileUploadId" $PersonalityUploadSpecReferred = Initialize-VcfPersonalityUploadSpecReferred -VCenterId "MyVCenterId" -ClusterId "MyClusterId" $PersonalityUploadSpec = Initialize-VcfPersonalityUploadSpec -UploadMode "One among: RAW, RAW_WITH_FILE_UPLOAD_ID, REFERRED" -UploadSpecRawMode $PersonalityUploadSpecRaw -UploadSpecRawWithFileUploadIdMode $PersonalityUploadSpecRawWithFileUploadId -UploadSpecReferredMode $PersonalityUploadSpecReferred -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalityUploadSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PersonalityUploadSpec = Initialize-VcfPersonalityUploadSpec -UploadMode "One among: RAW, RAW_WITH_FILE_UPLOAD_ID, REFERRED" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalityUploadSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PersonalityUploadSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfPersonalityUploadSpecRaw</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfPersonalityUploadSpecRawWithFileUploadId</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfPersonalityUploadSpecReferred</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPersonalityUploadSpecRaw</command:name> <command:verb>Initialize</command:verb> <command:noun>PersonalityUploadSpecRaw</command:noun> <maml:description> <maml:para>Personality upload specification for uploading the personality from raw files exported from avCenter cluster. This mode of uploading personality is useful when the source vCenter cluster is outside the target VCF deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Personality upload specification for uploading the personality from raw files exported from avCenter cluster. This mode of uploading personality is useful when the source vCenter cluster is outside the target VCF deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPersonalityUploadSpecRaw</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityInfoJSONFilePath</maml:name> <maml:Description> <maml:para>Personality Info JSON File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityJSONFilePath</maml:name> <maml:Description> <maml:para>Personality JSON File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityZIPFilePath</maml:name> <maml:Description> <maml:para>Personality Zip File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityISOFilePath</maml:name> <maml:Description> <maml:para>Personality ISO File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityInfoJSONFilePath</maml:name> <maml:Description> <maml:para>Personality Info JSON File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityJSONFilePath</maml:name> <maml:Description> <maml:para>Personality JSON File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityZIPFilePath</maml:name> <maml:Description> <maml:para>Personality Zip File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalityISOFilePath</maml:name> <maml:Description> <maml:para>Personality ISO File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PersonalityUploadSpecRaw = Initialize-VcfPersonalityUploadSpecRaw -PersonalityInfoJSONFilePath "MyPersonalityInfoJSONFilePath" -PersonalityJSONFilePath "MyPersonalityJSONFilePath" -PersonalityZIPFilePath "MyPersonalityZIPFilePath" -PersonalityISOFilePath "MyPersonalityISOFilePath" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalityUploadSpecRaw with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PersonalityUploadSpecRaw = Initialize-VcfPersonalityUploadSpecRaw -PersonalityInfoJSONFilePath "MyPersonalityInfoJSONFilePath" -PersonalityJSONFilePath "MyPersonalityJSONFilePath" -PersonalityZIPFilePath "MyPersonalityZIPFilePath" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalityUploadSpecRaw with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PersonalityUploadSpecRaw</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPersonalityUploadSpecRawWithFileUploadId</command:name> <command:verb>Initialize</command:verb> <command:noun>PersonalityUploadSpecRawWithFileUploadId</command:noun> <maml:description> <maml:para>Personality upload specification for uploading the personality from raw files exported from a vCenter cluster. This mode of uploading personality is useful when the source vCenter cluster is outside the target VCF deployment. User can upload files from a source location to SDDC Manager using v1/personalities/files API, which returns a file upload id. The id is then passed in this spec with Personality Upload Mode RAW_WITH_FILE_UPLOAD_ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Personality upload specification for uploading the personality from raw files exported from a vCenter cluster. This mode of uploading personality is useful when the source vCenter cluster is outside the target VCF deployment. User can upload files from a source location to SDDC Manager using v1/personalities/files API, which returns a file upload id. The id is then passed in this spec with Personality Upload Mode RAW_WITH_FILE_UPLOAD_ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPersonalityUploadSpecRawWithFileUploadId</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FileUploadId</maml:name> <maml:Description> <maml:para>Personality file upload id. This id is obtained by calling v1/personalities/files and uploading files into SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FileUploadId</maml:name> <maml:Description> <maml:para>Personality file upload id. This id is obtained by calling v1/personalities/files and uploading files into SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PersonalityUploadSpecRawWithFileUploadId = Initialize-VcfPersonalityUploadSpecRawWithFileUploadId -FileUploadId "MyFileUploadId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalityUploadSpecRawWithFileUploadId with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PersonalityUploadSpecRawWithFileUploadId = Initialize-VcfPersonalityUploadSpecRawWithFileUploadId -FileUploadId "MyFileUploadId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalityUploadSpecRawWithFileUploadId with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PersonalityUploadSpecRawWithFileUploadId</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPersonalityUploadSpecReferred</command:name> <command:verb>Initialize</command:verb> <command:noun>PersonalityUploadSpecReferred</command:noun> <maml:description> <maml:para>Personality upload specification for uploading the personality from a referred vCentercluster. This mode of uploading personality is useful when the source vCenter cluster is internal to the target VCF deployment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Personality upload specification for uploading the personality from a referred vCentercluster. This mode of uploading personality is useful when the source vCenter cluster is internal to the target VCF deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPersonalityUploadSpecReferred</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VCenterId</maml:name> <maml:Description> <maml:para>Source vCenter UUID from VCF inventory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Source cluster MOID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VCenterId</maml:name> <maml:Description> <maml:para>Source vCenter UUID from VCF inventory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Source cluster MOID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PersonalityUploadSpecReferred = Initialize-VcfPersonalityUploadSpecReferred -VCenterId "MyVCenterId" -ClusterId "MyClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalityUploadSpecReferred with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PersonalityUploadSpecReferred = Initialize-VcfPersonalityUploadSpecReferred -VCenterId "MyVCenterId" -ClusterId "MyClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPersonalityUploadSpecReferred with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PersonalityUploadSpecReferred</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPortgroupSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>PortgroupSpec</command:noun> <maml:description> <maml:para>This specification contains vCenter port group configurations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains vCenter port group configurations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPortgroupSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Port group name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransportType</maml:name> <maml:Description> <maml:para>Port group transport type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActiveUplinks</maml:name> <maml:Description> <maml:para>The list of active uplinks associated with portgroup</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandByUplinks</maml:name> <maml:Description> <maml:para>The list of standby uplinks associated with portgroup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TeamingPolicy</maml:name> <maml:Description> <maml:para>The teaming policy associated with the portgroup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Port group name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransportType</maml:name> <maml:Description> <maml:para>Port group transport type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActiveUplinks</maml:name> <maml:Description> <maml:para>The list of active uplinks associated with portgroup</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandByUplinks</maml:name> <maml:Description> <maml:para>The list of standby uplinks associated with portgroup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TeamingPolicy</maml:name> <maml:Description> <maml:para>The teaming policy associated with the portgroup.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPortgroupSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPortgroupSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PortgroupSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfPrecheckSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>PrecheckSpec</command:noun> <maml:description> <maml:para>Precheck System Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Precheck System Spec</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfPrecheckSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>List of resources for Precheck supported type DOMAIN, CLUSTER</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Resource></command:parameterValue> <dev:type> <maml:name>List<Resource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para> If specified, indicate the bundle applicability in the result</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mode</maml:name> <maml:Description> <maml:para> If specified, indicates the mode of the execution. Supported modes are UPGRADE and RECOVERY. UPGRADE is default mode. Specify RECOVERY for the Inventory Consistency Checks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resources</maml:name> <maml:Description> <maml:para>List of resources for Precheck supported type DOMAIN, CLUSTER</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Resource></command:parameterValue> <dev:type> <maml:name>List<Resource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para> If specified, indicate the bundle applicability in the result</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mode</maml:name> <maml:Description> <maml:para> If specified, indicates the mode of the execution. Supported modes are UPGRADE and RECOVERY. UPGRADE is default mode. Specify RECOVERY for the Inventory Consistency Checks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Fqdn "sfo-vc01.rainpole.io" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" -Name "MyName" -Sans "sfo-vc01.rainpole.io" $PrecheckSpec = Initialize-VcfPrecheckSpec -Resources $Resource -BundleId "MyBundleId" -Mode "MyMode" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPrecheckSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" $PrecheckSpec = Initialize-VcfPrecheckSpec -Resources $Resource </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfPrecheckSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/PrecheckSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfProductInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>ProductInfo</command:noun> <maml:description> <maml:para>Product Info and License Key Info</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Product Info and License Key Info</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfProductInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>License key of product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Product type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicensingMode</maml:name> <maml:Description> <maml:para>Licensing Mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyStatus</maml:name> <maml:Description> <maml:para>License key status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyExpirationDate</maml:name> <maml:Description> <maml:para>License key expiration date</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorResponse</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Error</command:parameterValue> <dev:type> <maml:name>Error</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>License key of product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Product type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicensingMode</maml:name> <maml:Description> <maml:para>Licensing Mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyStatus</maml:name> <maml:Description> <maml:para>License key status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKeyExpirationDate</maml:name> <maml:Description> <maml:para>License key expiration date</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ErrorResponse</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Error</command:parameterValue> <dev:type> <maml:name>Error</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $ProductInfo = Initialize-VcfProductInfo -LicenseKey "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" -Type "One among: VCENTER, NSXT, VSAN, WCP, ESXI" -LicensingMode "One among: SUBSCRIPTION, PERPETUAL, MIXED" -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -LicenseKeyExpirationDate "2021-04-08T04:37:51.662Z" -ErrorResponse $Error </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfProductInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ProductInfo = Initialize-VcfProductInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfProductInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ProductInfo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfError</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfProductVersion</command:name> <command:verb>Initialize</command:verb> <command:noun>ProductVersion</command:noun> <maml:description> <maml:para>Details of the product/component for the release.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Details of the product/component for the release.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfProductVersion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the product. e.g ESX</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Version for the product, e.g 6.7.0-11675023</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PublicName</maml:name> <maml:Description> <maml:para>Public name of the product, e.g VMware ESXi</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseURL</maml:name> <maml:Description> <maml:para>URL for the release.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdditionalMetadata</maml:name> <maml:Description> <maml:para>any additional metadata</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the product. e.g ESX</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Version for the product, e.g 6.7.0-11675023</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PublicName</maml:name> <maml:Description> <maml:para>Public name of the product, e.g VMware ESXi</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseURL</maml:name> <maml:Description> <maml:para>URL for the release.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdditionalMetadata</maml:name> <maml:Description> <maml:para>any additional metadata</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" -ReleaseURL "MyReleaseURL" -AdditionalMetadata "MyAdditionalMetadata" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfProductVersion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfProductVersion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ProductVersion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfProductVersionCatalog</command:name> <command:verb>Initialize</command:verb> <command:noun>ProductVersionCatalog</command:noun> <maml:description> <maml:para>LCM Product Version Catalog that contains async patches for VMware Cloud foundation components (VC/ESX/NSX) that's used by Life cycle manager.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>LCM Product Version Catalog that contains async patches for VMware Cloud foundation components (VC/ESX/NSX) that's used by Life cycle manager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfProductVersionCatalog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Product Version catalog version supported by VCF</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para>Product Version catalog sequence number which signifies an update in the product version catalog</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTime</maml:name> <maml:Description> <maml:para>Creation time for the Product Version catalog e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PublishedTime</maml:name> <maml:Description> <maml:para>Time of publish of the Product Version catalog e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Patches</maml:name> <maml:Description> <maml:para>Patches used for the product version catalog</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<Patch>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<Patch>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Product Version catalog version supported by VCF</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para>Product Version catalog sequence number which signifies an update in the product version catalog</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTime</maml:name> <maml:Description> <maml:para>Creation time for the Product Version catalog e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PublishedTime</maml:name> <maml:Description> <maml:para>Time of publish of the Product Version catalog e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Patches</maml:name> <maml:Description> <maml:para>Patches used for the product version catalog</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<Patch>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<Patch>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ProductVersionCatalog = Initialize-VcfProductVersionCatalog -_Version 0 -SequenceNumber 0 -CreationTime "MyCreationTime" -PublishedTime "MyPublishedTime" -Patches @{ key_example = $BundleInfo = Initialize-VcfBundleInfo -Id "MyId" -Type "MyType" -Name "MyName" $Artifact = Initialize-VcfArtifact -Bundles $BundleInfo $Patch = Initialize-VcfPatch -ProductVersion "MyProductVersion" -Artifacts $Artifact } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfProductVersionCatalog with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ProductVersionCatalog = Initialize-VcfProductVersionCatalog </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfProductVersionCatalog with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ProductVersionCatalog</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetProductVersionCatalog</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetProductVersionCatalog</command:noun> <maml:description> <maml:para>Get product version catalog</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get product version catalog. There should be only one valid product version catalog in the System.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetProductVersionCatalog</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProductVersionCatalog</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetProductVersionCatalog </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetProductVersionCatalog with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetProductVersionCatalog </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetProductVersionCatalog with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/product-version-catalog/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUploadProductVersionCatalog</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUploadProductVersionCatalog</command:noun> <maml:description> <maml:para>Upload product version catalog</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upload product version catalog. Make sure product version is a valid one.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUploadProductVersionCatalog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersionCatalog</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProductVersionCatalog</command:parameterValue> <dev:type> <maml:name>ProductVersionCatalog</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductVersionCatalog</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProductVersionCatalog</command:parameterValue> <dev:type> <maml:name>ProductVersionCatalog</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ProductVersionCatalog = Initialize-VcfProductVersionCatalog -_Version 0 -SequenceNumber 0 -CreationTime "MyCreationTime" -PublishedTime "MyPublishedTime" -Patches @{ key_example = $BundleInfo = Initialize-VcfBundleInfo -Id "MyId" -Type "MyType" -Name "MyName" $Artifact = Initialize-VcfArtifact -Bundles $BundleInfo $Patch = Initialize-VcfPatch -ProductVersion "MyProductVersion" -Artifacts $Artifact } Invoke-VcfUploadProductVersionCatalog -productVersionCatalog $productVersionCatalog </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadProductVersionCatalog with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ProductVersionCatalog = Initialize-VcfProductVersionCatalog Invoke-VcfUploadProductVersionCatalog -productVersionCatalog $productVersionCatalog </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUploadProductVersionCatalog with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/product-version-catalog/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfProductVersionCatalog</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfProxyConfiguration</command:name> <command:verb>Initialize</command:verb> <command:noun>ProxyConfiguration</command:noun> <maml:description> <maml:para>Proxy Configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Proxy Configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfProxyConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsConfigured</maml:name> <maml:Description> <maml:para>Is proxy configured</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsEnabled</maml:name> <maml:Description> <maml:para>Is proxy enabled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Host</maml:name> <maml:Description> <maml:para>IP address/FQDN of proxy server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Port of proxy server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransferProtocol</maml:name> <maml:Description> <maml:para>Proxy transfer protocol, default value is HTTP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(TransferProtocolEnum)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>User name to connect</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>User password to connect, will return null on reading</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAuthenticated</maml:name> <maml:Description> <maml:para>Is proxy authenticated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsConfigured</maml:name> <maml:Description> <maml:para>Is proxy configured</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsEnabled</maml:name> <maml:Description> <maml:para>Is proxy enabled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Host</maml:name> <maml:Description> <maml:para>IP address/FQDN of proxy server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Port of proxy server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransferProtocol</maml:name> <maml:Description> <maml:para>Proxy transfer protocol, default value is HTTP</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(TransferProtocolEnum)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>User name to connect</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>User password to connect, will return null on reading</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAuthenticated</maml:name> <maml:Description> <maml:para>Is proxy authenticated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ProxyConfiguration = Initialize-VcfProxyConfiguration -IsConfigured $false -IsEnabled $false -Host "10.0.0.250" -Port 3128 -TransferProtocol "HTTP" -Username "MyUsername" -Password "MyPassword" -IsAuthenticated $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfProxyConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ProxyConfiguration = Initialize-VcfProxyConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfProxyConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ProxyConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetProxyConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetProxyConfiguration</command:noun> <maml:description> <maml:para>Get the current Proxy configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the current Proxy configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetProxyConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ProxyConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetProxyConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetProxyConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetProxyConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetProxyConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/proxy-configuration/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateProxyConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateProxyConfiguration</command:noun> <maml:description> <maml:para>Update Proxy configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update Proxy configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateProxyConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProxyConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProxyConfiguration</command:parameterValue> <dev:type> <maml:name>ProxyConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProxyConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProxyConfiguration</command:parameterValue> <dev:type> <maml:name>ProxyConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ProxyConfiguration = Initialize-VcfProxyConfiguration -IsConfigured $false -IsEnabled $false -Host "10.0.0.250" -Port 3128 -TransferProtocol "HTTP" -Username "MyUsername" -Password "MyPassword" -IsAuthenticated $false Invoke-VcfUpdateProxyConfiguration -proxyConfiguration $proxyConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateProxyConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ProxyConfiguration = Initialize-VcfProxyConfiguration Invoke-VcfUpdateProxyConfiguration -proxyConfiguration $proxyConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateProxyConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/proxy-configuration/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfProxyConfiguration</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetPsc</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetPsc</command:noun> <maml:description> <maml:para>Retrieve details of a Platform Service Controller (PSC)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetPsc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>PSC ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>PSC ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Psc</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetPsc -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPsc with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetPsc -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPsc with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/pscs/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetPscs</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetPscs</command:noun> <maml:description> <maml:para>Retrieve a list of Platform Service Controller (PSC)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetPscs</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfPsc</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetPscs </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPscs with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetPscs </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPscs with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/pscs/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfReconciliationForResource</command:name> <command:verb>Initialize</command:verb> <command:noun>ReconciliationForResource</command:noun> <maml:description> <maml:para>Describes Configuration Reconciliation operation(s) for a resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Describes Configuration Reconciliation operation(s) for a resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfReconciliationForResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Target resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplyAll</maml:name> <maml:Description> <maml:para>All application flag. Indicates if all applicable config drifts must be applied</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Target resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplyAll</maml:name> <maml:Description> <maml:para>All application flag. Indicates if all applicable config drifts must be applied</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ReconciliationForResource = Initialize-VcfReconciliationForResource -ResourceId "Could be ID of domain or a nested child resource eg cluster, host etc." -ApplyAll $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfReconciliationForResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ReconciliationForResource = Initialize-VcfReconciliationForResource -ResourceId "Could be ID of domain or a nested child resource eg cluster, host etc." -ApplyAll $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfReconciliationForResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ReconciliationForResource</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfRelease</command:name> <command:verb>Initialize</command:verb> <command:noun>Release</command:noun> <maml:description> <maml:para>Model for releases with their description and product version</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model for releases with their description and product version</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfRelease</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Product</maml:name> <maml:Description> <maml:para>Name of the product e.g. \"VCF\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Version of the release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MinCompatibleVcfVersion</maml:name> <maml:Description> <maml:para>Minimum compatible VCF version, used to represent compatibility of SDDC Manager and VMware BOM components</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Release description with all major features. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>Release date e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Bom</maml:name> <maml:Description> <maml:para>Release bill of materials</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ProductVersion></command:parameterValue> <dev:type> <maml:name>List<ProductVersion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsApplicable</maml:name> <maml:Description> <maml:para>[Deprecated] Whether bundle is applicable or not.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotApplicableReason</maml:name> <maml:Description> <maml:para>[Deprecated] Incompatibility reason for not applicable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Sku</maml:name> <maml:Description> <maml:para>Release sku specific patch and bill of materials</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SkuBomDetails></command:parameterValue> <dev:type> <maml:name>List<SkuBomDetails></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Updates</maml:name> <maml:Description> <maml:para>Collection of release updates</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ReleaseUpdate></command:parameterValue> <dev:type> <maml:name>List<ReleaseUpdate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PatchBundles</maml:name> <maml:Description> <maml:para>List of patch bundles in this release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<PatchBundle></command:parameterValue> <dev:type> <maml:name>List<PatchBundle></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Eol</maml:name> <maml:Description> <maml:para>Release eol information e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeOrder</maml:name> <maml:Description> <maml:para>Custom upgrade order. Comma separated list of components in upgrade order. Supported components types: NSX_T_MANAGER, VCENTER, ESX_HOST. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Product</maml:name> <maml:Description> <maml:para>Name of the product e.g. \"VCF\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Version of the release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MinCompatibleVcfVersion</maml:name> <maml:Description> <maml:para>Minimum compatible VCF version, used to represent compatibility of SDDC Manager and VMware BOM components</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Release description with all major features. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>Release date e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Bom</maml:name> <maml:Description> <maml:para>Release bill of materials</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ProductVersion></command:parameterValue> <dev:type> <maml:name>List<ProductVersion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsApplicable</maml:name> <maml:Description> <maml:para>[Deprecated] Whether bundle is applicable or not.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotApplicableReason</maml:name> <maml:Description> <maml:para>[Deprecated] Incompatibility reason for not applicable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Sku</maml:name> <maml:Description> <maml:para>Release sku specific patch and bill of materials</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SkuBomDetails></command:parameterValue> <dev:type> <maml:name>List<SkuBomDetails></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Updates</maml:name> <maml:Description> <maml:para>Collection of release updates</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ReleaseUpdate></command:parameterValue> <dev:type> <maml:name>List<ReleaseUpdate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PatchBundles</maml:name> <maml:Description> <maml:para>List of patch bundles in this release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<PatchBundle></command:parameterValue> <dev:type> <maml:name>List<PatchBundle></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Eol</maml:name> <maml:Description> <maml:para>Release eol information e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeOrder</maml:name> <maml:Description> <maml:para>Custom upgrade order. Comma separated list of components in upgrade order. Supported components types: NSX_T_MANAGER, VCENTER, ESX_HOST. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" -ReleaseURL "MyReleaseURL" -AdditionalMetadata "MyAdditionalMetadata" $SkuSpecificPatchBundles = Initialize-VcfSkuSpecificPatchBundles -BundleType "MyBundleType" -BundleVersion "MyBundleVersion" -_Version "My_Version" $SkuBomDetails = Initialize-VcfSkuBomDetails -Name "MyName" -Description "MyDescription" -SkuSpecificPatchBundles $SkuSpecificPatchBundles -Bom $ProductVersion $ReleaseUpdate = Initialize-VcfReleaseUpdate -Id "MyId" -ProductName "MyProductName" -BaseProductVersion "MyBaseProductVersion" -Description "MyDescription" -ReleaseUpdateURL "MyReleaseUpdateURL" -ReleaseDate "MyReleaseDate" $PatchBundle = Initialize-VcfPatchBundle -BundleId "MyBundleId" -BundleType "MyBundleType" -BundleElements "MyBundleElements" -CumulativeFromVcfVersion "MyCumulativeFromVcfVersion" $Release = Initialize-VcfRelease -Product "MyProduct" -_Version "My_Version" -MinCompatibleVcfVersion "MyMinCompatibleVcfVersion" -Description "MyDescription" -ReleaseDate "MyReleaseDate" -Bom $ProductVersion -IsApplicable $false -NotApplicableReason "MyNotApplicableReason" -Sku $SkuBomDetails -Updates $ReleaseUpdate -PatchBundles $PatchBundle -Eol "MyEol" -UpgradeOrder "MyUpgradeOrder" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfRelease with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" $Release = Initialize-VcfRelease -Product "MyProduct" -_Version "My_Version" -MinCompatibleVcfVersion "MyMinCompatibleVcfVersion" -Description "MyDescription" -ReleaseDate "MyReleaseDate" -Bom $ProductVersion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfRelease with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Release</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetFutureReleases</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetFutureReleases</command:noun> <maml:description> <maml:para>Retrive a list of future release by domain ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns all known to the system future target versions for a domain. If some of them are not allowed (e.g. stepping stone) includes message why. If the domain does not have a product configured at that point, that product will not be included in the BOM or patch bundle list in each release.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetFutureReleases</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID to get all feature target versions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID to get all feature target versions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfDomainFutureRelease</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetFutureReleases -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetFutureReleases with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetFutureReleases -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetFutureReleases with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/domains/domainid/future-releases/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetReleases</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetReleases</command:noun> <maml:description> <maml:para>Retrieve a list of release including current and target versions</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all Releases, with option to get current release for a domain, get release by version or get future releases for a versionor get all the applicable target release.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetReleases</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID to get current release of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionEq</maml:name> <maml:Description> <maml:para>Release version to get its release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxRailVersionEq</maml:name> <maml:Description> <maml:para>Release VxRail version to get its release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionGt</maml:name> <maml:Description> <maml:para>Release version to get its future releases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxRailVersionGt</maml:name> <maml:Description> <maml:para>Release vxrail version to get its future releases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicableForVersion</maml:name> <maml:Description> <maml:para>Release version to get applicable releases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicableForVxRailVersion</maml:name> <maml:Description> <maml:para>Release VxRail version to get applicable releases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GetFutureReleases</maml:name> <maml:Description> <maml:para>[Deprecated] Get all future releases for a given domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID to get current release of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionEq</maml:name> <maml:Description> <maml:para>Release version to get its release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxRailVersionEq</maml:name> <maml:Description> <maml:para>Release VxRail version to get its release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionGt</maml:name> <maml:Description> <maml:para>Release version to get its future releases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VxRailVersionGt</maml:name> <maml:Description> <maml:para>Release vxrail version to get its future releases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicableForVersion</maml:name> <maml:Description> <maml:para>Release version to get applicable releases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicableForVxRailVersion</maml:name> <maml:Description> <maml:para>Release VxRail version to get applicable releases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GetFutureReleases</maml:name> <maml:Description> <maml:para>[Deprecated] Get all future releases for a given domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfRelease</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetReleases -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd -versionEq 3.9.0 -vxRailVersionEq 3.9.0 -versionGt 4.0.0.0 -vxRailVersionGt 7.0.0.0 -applicableForVersion 4.0.1.0 -applicableForVxRailVersion 4.0.1.0 -getFutureReleases $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetReleases with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetReleases </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetReleases with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSystemRelease</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSystemRelease</command:noun> <maml:description> <maml:para>Retrieve the lowest deployed release of VMware Cloud Foundation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns release for the lowest deployed VCF version for a domain on the environment.If Management domain is ahead of WLD domain, VCF BOM version for the WLDdomain will be returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSystemRelease</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Release</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSystemRelease </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSystemRelease with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSystemRelease </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSystemRelease with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/system/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfReleaseUpdate</command:name> <command:verb>Initialize</command:verb> <command:noun>ReleaseUpdate</command:noun> <maml:description> <maml:para>Update to a given release</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update to a given release</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfReleaseUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Release version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductName</maml:name> <maml:Description> <maml:para>Product name for which the release update is provided</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseProductVersion</maml:name> <maml:Description> <maml:para>Base product version for the release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the release update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseUpdateURL</maml:name> <maml:Description> <maml:para>URL to the release update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>Release date e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Release version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductName</maml:name> <maml:Description> <maml:para>Product name for which the release update is provided</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseProductVersion</maml:name> <maml:Description> <maml:para>Base product version for the release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of the release update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseUpdateURL</maml:name> <maml:Description> <maml:para>URL to the release update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>Release date e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ReleaseUpdate = Initialize-VcfReleaseUpdate -Id "MyId" -ProductName "MyProductName" -BaseProductVersion "MyBaseProductVersion" -Description "MyDescription" -ReleaseUpdateURL "MyReleaseUpdateURL" -ReleaseDate "MyReleaseDate" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfReleaseUpdate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ReleaseUpdate = Initialize-VcfReleaseUpdate -Id "MyId" -ProductName "MyProductName" -BaseProductVersion "MyBaseProductVersion" -Description "MyDescription" -ReleaseDate "MyReleaseDate" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfReleaseUpdate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ReleaseUpdate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResource</command:name> <command:verb>Initialize</command:verb> <command:noun>Resource</command:noun> <maml:description> <maml:para>Represents the resource in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the resource in the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>Resource FQDN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Sans</maml:name> <maml:Description> <maml:para>Subject alternative name(s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>Resource FQDN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Sans</maml:name> <maml:Description> <maml:para>Subject alternative name(s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Fqdn "sfo-vc01.rainpole.io" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" -Name "MyName" -Sans "sfo-vc01.rainpole.io" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Resource</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourceCertificateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceCertificateSpec</command:noun> <maml:description> <maml:para>This specification contains resource certificate details. Either resourceId or resourceFqdn should be provided. Either certificateChain or both resourceCertificate and caCertificate should be provided.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains resource certificate details. Either resourceId or resourceFqdn should be provided. Either certificateChain or both resourceCertificate and caCertificate should be provided.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourceCertificateSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFqdn</maml:name> <maml:Description> <maml:para>Resource FQDN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCertificate</maml:name> <maml:Description> <maml:para>Resource Certificate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CaCertificate</maml:name> <maml:Description> <maml:para>CA Certificate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateChain</maml:name> <maml:Description> <maml:para>Certificate Chain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFqdn</maml:name> <maml:Description> <maml:para>Resource FQDN</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCertificate</maml:name> <maml:Description> <maml:para>Resource Certificate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CaCertificate</maml:name> <maml:Description> <maml:para>CA Certificate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateChain</maml:name> <maml:Description> <maml:para>Certificate Chain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceCertificateSpec = Initialize-VcfResourceCertificateSpec -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -ResourceFqdn "sfo-vc01.rainpole.io" -ResourceCertificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" -CaCertificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" -CertificateChain "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceCertificateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceCertificateSpec = Initialize-VcfResourceCertificateSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceCertificateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourceCertificateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourceCredentials</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceCredentials</command:noun> <maml:description> <maml:para>Represents a resource along with its list of credentials to be changed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a resource along with its list of credentials to be changed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourceCredentials</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Resource name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Authenticated Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credentials</maml:name> <maml:Description> <maml:para>Credentials of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BaseCredential></command:parameterValue> <dev:type> <maml:name>List<BaseCredential></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Resource name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Authenticated Resource Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credentials</maml:name> <maml:Description> <maml:para>Credentials of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BaseCredential></command:parameterValue> <dev:type> <maml:name>List<BaseCredential></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BaseCredential = Initialize-VcfBaseCredential -CredentialType "One among: SSO, SSH, API, FTP, AUDIT" -AccountType "One among: USER, SYSTEM, SERVICE" -Username "MyUsername" -Password "MyPassword" $ResourceCredentials = Initialize-VcfResourceCredentials -ResourceName "MyResourceName" -ResourceId "MyResourceId" -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -Credentials $BaseCredential </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceCredentials with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BaseCredential = Initialize-VcfBaseCredential -Username "MyUsername" $ResourceCredentials = Initialize-VcfResourceCredentials -ResourceType "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, NSX_ALB, BACKUP" -Credentials $BaseCredential </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceCredentials with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourceCredentials</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourceFunctionalities</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceFunctionalities</command:noun> <maml:description> <maml:para>Defines a resource functionality specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Defines a resource functionality specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourceFunctionalities</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Type of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>ID of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Functionalities</maml:name> <maml:Description> <maml:para>List of functionalities associated with the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Functionality></command:parameterValue> <dev:type> <maml:name>List<Functionality></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Type of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>ID of the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Functionalities</maml:name> <maml:Description> <maml:para>List of functionalities associated with the resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Functionality></command:parameterValue> <dev:type> <maml:name>List<Functionality></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Functionality = Initialize-VcfFunctionality -Type "Sample values: HOST_COMMISSION, HOST_DECOMMISSION" -IsAllowed $true -ErrorMessage "MyErrorMessage" $ResourceFunctionalities = Initialize-VcfResourceFunctionalities -ResourceType "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER" -ResourceId "MyResourceId" -Functionalities $Functionality </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceFunctionalities with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceFunctionalities = Initialize-VcfResourceFunctionalities -ResourceType "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceFunctionalities with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourceFunctionalities</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetResourceFunctionalities</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetResourceFunctionalities</command:noun> <maml:description> <maml:para>Get Resource Functionalities</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetResourceFunctionalities</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FunctionalityType</maml:name> <maml:Description> <maml:para>Functionality type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Resource IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAllowed</maml:name> <maml:Description> <maml:para>Allowed or disallowed resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParentResourceType</maml:name> <maml:Description> <maml:para>Parent resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FunctionalityType</maml:name> <maml:Description> <maml:para>Functionality type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Resource IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAllowed</maml:name> <maml:Description> <maml:para>Allowed or disallowed resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParentResourceType</maml:name> <maml:Description> <maml:para>Parent resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfResourceFunctionalities</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourceFunctionalities -resourceType "MyresourceType" -functionalityType "MyfunctionalityType" -resourceIds "MyresourceIds" -isAllowed $true -parentResourceType "MyparentResourceType" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourceFunctionalities with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourceFunctionalities </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourceFunctionalities with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resource-functionalities/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetResourcesFunctionalitiesAllowedGlobal</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetResourcesFunctionalitiesAllowedGlobal</command:noun> <maml:description> <maml:para>Get Resource Functionalities Allowed Global Configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetResourcesFunctionalitiesAllowedGlobal</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ResourceFunctionalitiesGlobalConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourcesFunctionalitiesAllowedGlobal </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourcesFunctionalitiesAllowedGlobal with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourcesFunctionalitiesAllowedGlobal </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourcesFunctionalitiesAllowedGlobal with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resource-functionalities/global/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateResourcesFunctionalities</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateResourcesFunctionalities</command:noun> <maml:description> <maml:para>Update Resources Functionalities</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateResourcesFunctionalities</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFunctionalitiesUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceFunctionalitiesUpdateSpec</command:parameterValue> <dev:type> <maml:name>ResourceFunctionalitiesUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFunctionalitiesUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceFunctionalitiesUpdateSpec</command:parameterValue> <dev:type> <maml:name>ResourceFunctionalitiesUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ResourceFunctionalitiesCaller</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Functionality = Initialize-VcfFunctionality -Type "Sample values: HOST_COMMISSION, HOST_DECOMMISSION" -IsAllowed $true -ErrorMessage "MyErrorMessage" $ResourceFunctionalities = Initialize-VcfResourceFunctionalities -ResourceType "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER" -ResourceId "MyResourceId" -Functionalities $Functionality $ResourceFunctionalitiesUpdateSpec = Initialize-VcfResourceFunctionalitiesUpdateSpec -ServiceId "MyServiceId" -OperationName "MyOperationName" -OperationId "MyOperationId" -ResourceFunctionalities $ResourceFunctionalities Invoke-VcfUpdateResourcesFunctionalities -resourceFunctionalitiesUpdateSpec $resourceFunctionalitiesUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateResourcesFunctionalities with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceFunctionalities = Initialize-VcfResourceFunctionalities -ResourceType "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER" $ResourceFunctionalitiesUpdateSpec = Initialize-VcfResourceFunctionalitiesUpdateSpec -ServiceId "MyServiceId" -OperationName "MyOperationName" -OperationId "MyOperationId" -ResourceFunctionalities $ResourceFunctionalities Invoke-VcfUpdateResourcesFunctionalities -resourceFunctionalitiesUpdateSpec $resourceFunctionalitiesUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateResourcesFunctionalities with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resource-functionalities/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfResourceFunctionalitiesUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateResourcesFunctionalities1</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateResourcesFunctionalities1</command:noun> <maml:description> <maml:para>Update Resources Functionalities Is Allowed Global Configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateResourcesFunctionalities1</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFunctionalitiesGlobalUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceFunctionalitiesGlobalUpdateSpec</command:parameterValue> <dev:type> <maml:name>ResourceFunctionalitiesGlobalUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFunctionalitiesGlobalUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceFunctionalitiesGlobalUpdateSpec</command:parameterValue> <dev:type> <maml:name>ResourceFunctionalitiesGlobalUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ResourceFunctionalitiesGlobalConfigurationCaller</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceFunctionalitiesGlobalUpdateSpec = Initialize-VcfResourceFunctionalitiesGlobalUpdateSpec -ServiceId "MyServiceId" -OperationName "MyOperationName" -OperationId "MyOperationId" -IsAllowed $true Invoke-VcfUpdateResourcesFunctionalities1 -resourceFunctionalitiesGlobalUpdateSpec $resourceFunctionalitiesGlobalUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateResourcesFunctionalities1 with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceFunctionalitiesGlobalUpdateSpec = Initialize-VcfResourceFunctionalitiesGlobalUpdateSpec -ServiceId "MyServiceId" -OperationName "MyOperationName" -OperationId "MyOperationId" -IsAllowed $true Invoke-VcfUpdateResourcesFunctionalities1 -resourceFunctionalitiesGlobalUpdateSpec $resourceFunctionalitiesGlobalUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateResourcesFunctionalities1 with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resource-functionalities/global/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfResourceFunctionalitiesGlobalUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourceFunctionalitiesGlobalUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceFunctionalitiesGlobalUpdateSpec</command:noun> <maml:description> <maml:para>Resource Functionality Global Caller update specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resource Functionality Global Caller update specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourceFunctionalitiesGlobalUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para>The identifier of the service associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationName</maml:name> <maml:Description> <maml:para>The name of the operation associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para>The identifier of the operation associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAllowed</maml:name> <maml:Description> <maml:para>Flag indicating if all of the functionalities are allowed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para>The identifier of the service associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationName</maml:name> <maml:Description> <maml:para>The name of the operation associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para>The identifier of the operation associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAllowed</maml:name> <maml:Description> <maml:para>Flag indicating if all of the functionalities are allowed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceFunctionalitiesGlobalUpdateSpec = Initialize-VcfResourceFunctionalitiesGlobalUpdateSpec -ServiceId "MyServiceId" -OperationName "MyOperationName" -OperationId "MyOperationId" -IsAllowed $true </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceFunctionalitiesGlobalUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceFunctionalitiesGlobalUpdateSpec = Initialize-VcfResourceFunctionalitiesGlobalUpdateSpec -ServiceId "MyServiceId" -OperationName "MyOperationName" -OperationId "MyOperationId" -IsAllowed $true </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceFunctionalitiesGlobalUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourceFunctionalitiesGlobalUpdateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourceFunctionalitiesUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceFunctionalitiesUpdateSpec</command:noun> <maml:description> <maml:para>Resource Functionality Caller update specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resource Functionality Caller update specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourceFunctionalitiesUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para>The identifier of the service associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationName</maml:name> <maml:Description> <maml:para>The name of the operation associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para>The identifier of the operation associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFunctionalities</maml:name> <maml:Description> <maml:para>List of resource functionalities associated with the caller</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceFunctionalities></command:parameterValue> <dev:type> <maml:name>List<ResourceFunctionalities></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para>The identifier of the service associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationName</maml:name> <maml:Description> <maml:para>The name of the operation associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para>The identifier of the operation associated with the resource functionalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFunctionalities</maml:name> <maml:Description> <maml:para>List of resource functionalities associated with the caller</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceFunctionalities></command:parameterValue> <dev:type> <maml:name>List<ResourceFunctionalities></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Functionality = Initialize-VcfFunctionality -Type "Sample values: HOST_COMMISSION, HOST_DECOMMISSION" -IsAllowed $true -ErrorMessage "MyErrorMessage" $ResourceFunctionalities = Initialize-VcfResourceFunctionalities -ResourceType "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER" -ResourceId "MyResourceId" -Functionalities $Functionality $ResourceFunctionalitiesUpdateSpec = Initialize-VcfResourceFunctionalitiesUpdateSpec -ServiceId "MyServiceId" -OperationName "MyOperationName" -OperationId "MyOperationId" -ResourceFunctionalities $ResourceFunctionalities </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceFunctionalitiesUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceFunctionalities = Initialize-VcfResourceFunctionalities -ResourceType "One among: SYSTEM, HOST, CLUSTER, DOMAIN, EDGE_CLUSTER" $ResourceFunctionalitiesUpdateSpec = Initialize-VcfResourceFunctionalitiesUpdateSpec -ServiceId "MyServiceId" -OperationName "MyOperationName" -OperationId "MyOperationId" -ResourceFunctionalities $ResourceFunctionalities </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceFunctionalitiesUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourceFunctionalitiesUpdateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourceInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceInfo</command:noun> <maml:description> <maml:para>Resource info</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resource info</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain Identifier</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster Id of resourceInfo</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostId</maml:name> <maml:Description> <maml:para>Host Id of resourceInfo</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain Identifier</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Cluster Id of resourceInfo</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HostId</maml:name> <maml:Description> <maml:para>Host Id of resourceInfo</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" -ClusterId "a0bf0f65-f719-4c2d-980a-29a9094045b5" -HostId "b0bf0f65-f719-4c2d-980a-29a9094045b5" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourceInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourceLicensingInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceLicensingInfo</command:noun> <maml:description> <maml:para>Resource Licensing Info</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resource Licensing Info</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourceLicensingInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceInfo</command:parameterValue> <dev:type> <maml:name>ResourceInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProductInfo</command:parameterValue> <dev:type> <maml:name>ProductInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceInfo</command:parameterValue> <dev:type> <maml:name>ResourceInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProductInfo</command:parameterValue> <dev:type> <maml:name>ProductInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" -ClusterId "a0bf0f65-f719-4c2d-980a-29a9094045b5" -HostId "b0bf0f65-f719-4c2d-980a-29a9094045b5" $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $ProductInfo = Initialize-VcfProductInfo -LicenseKey "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" -Type "One among: VCENTER, NSXT, VSAN, WCP, ESXI" -LicensingMode "One among: SUBSCRIPTION, PERPETUAL, MIXED" -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -LicenseKeyExpirationDate "2021-04-08T04:37:51.662Z" -ErrorResponse $Error $ResourceLicensingInfo = Initialize-VcfResourceLicensingInfo -ResourceInfo $ResourceInfo -ProductInfo $ProductInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceLicensingInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" $ResourceLicensingInfo = Initialize-VcfResourceLicensingInfo -ResourceInfo $ResourceInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceLicensingInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourceLicensingInfo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfResourceInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfProductInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourcesLicenseCheckSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourcesLicenseCheckSpec</command:noun> <maml:description> <maml:para>Resources license check spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resources license check spec</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourcesLicenseCheckSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseCheckResources</maml:name> <maml:Description> <maml:para>A list of resources for which license check needs to be performed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<LicenseCheckResource></command:parameterValue> <dev:type> <maml:name>List<LicenseCheckResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForAllDomains</maml:name> <maml:Description> <maml:para>Value that defines whether to get license check for all domains or not</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseCheckResources</maml:name> <maml:Description> <maml:para>A list of resources for which license check needs to be performed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<LicenseCheckResource></command:parameterValue> <dev:type> <maml:name>List<LicenseCheckResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForAllDomains</maml:name> <maml:Description> <maml:para>Value that defines whether to get license check for all domains or not</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceInfo = Initialize-VcfResourceInfo -DomainId "f0bf0f65-f719-4c2d-980a-29a9094045b5" -ClusterId "a0bf0f65-f719-4c2d-980a-29a9094045b5" -HostId "b0bf0f65-f719-4c2d-980a-29a9094045b5" $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $ProductInfo = Initialize-VcfProductInfo -LicenseKey "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX" -Type "One among: VCENTER, NSXT, VSAN, WCP, ESXI" -LicensingMode "One among: SUBSCRIPTION, PERPETUAL, MIXED" -LicenseKeyStatus "One among: EXPIRED, ACTIVE, NEVER_EXPIRES" -LicenseKeyExpirationDate "2021-04-08T04:37:51.662Z" -ErrorResponse $Error $LicenseCheckResource = Initialize-VcfLicenseCheckResource -ResourceInfo $ResourceInfo -ProductInfo $ProductInfo $ResourcesLicenseCheckSpec = Initialize-VcfResourcesLicenseCheckSpec -LicenseCheckResources $LicenseCheckResource -ForAllDomains $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourcesLicenseCheckSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourcesLicenseCheckSpec = Initialize-VcfResourcesLicenseCheckSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourcesLicenseCheckSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourcesLicenseCheckSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourceUpgradeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceUpgradeSpec</command:noun> <maml:description> <maml:para>Resource Upgrade Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resource Upgrade Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourceUpgradeSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource ID for Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ShutdownVms</maml:name> <maml:Description> <maml:para>If Resource Type is UNASSIGNED_HOST, set flag for enabling shutting down VM's before Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ToVersion</maml:name> <maml:Description> <maml:para>If Resource Type is UNASSIGNED_HOST, set the target version for Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ScheduledTimestamp</maml:name> <maml:Description> <maml:para>Upgrade Scheduled Time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeNow</maml:name> <maml:Description> <maml:para>Flag for enabling Upgrade Now. If true, scheduledTimestamp is ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalitySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalitySpec</command:parameterValue> <dev:type> <maml:name>PersonalitySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CustomISOSpec</command:parameterValue> <dev:type> <maml:name>CustomISOSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableQuickboot</maml:name> <maml:Description> <maml:para>Flag for requesting Quick Boot for ESXi upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EvacuateOfflineVms</maml:name> <maml:Description> <maml:para>Flag for requesting Evacuation of Offline VMs for ESXi upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsxUpgradeOptionsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EsxUpgradeOptionsSpec</command:parameterValue> <dev:type> <maml:name>EsxUpgradeOptionsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource ID for Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ShutdownVms</maml:name> <maml:Description> <maml:para>If Resource Type is UNASSIGNED_HOST, set flag for enabling shutting down VM's before Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ToVersion</maml:name> <maml:Description> <maml:para>If Resource Type is UNASSIGNED_HOST, set the target version for Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ScheduledTimestamp</maml:name> <maml:Description> <maml:para>Upgrade Scheduled Time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeNow</maml:name> <maml:Description> <maml:para>Flag for enabling Upgrade Now. If true, scheduledTimestamp is ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PersonalitySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PersonalitySpec</command:parameterValue> <dev:type> <maml:name>PersonalitySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomIsoSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CustomISOSpec</command:parameterValue> <dev:type> <maml:name>CustomISOSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableQuickboot</maml:name> <maml:Description> <maml:para>Flag for requesting Quick Boot for ESXi upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EvacuateOfflineVms</maml:name> <maml:Description> <maml:para>Flag for requesting Evacuation of Offline VMs for ESXi upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsxUpgradeOptionsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EsxUpgradeOptionsSpec</command:parameterValue> <dev:type> <maml:name>EsxUpgradeOptionsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PackageSpec = Initialize-VcfPackageSpec -Name "MyName" -_Version "My_Version" $HardwareSupportSpec = Initialize-VcfHardwareSupportSpec -Name "MyName" -PackageSpec $PackageSpec $PersonalitySpec = Initialize-VcfPersonalitySpec -PersonalityId "MyPersonalityId" -HardwareSupportSpecs $HardwareSupportSpec $CustomISOSpec = Initialize-VcfCustomISOSpec -Id "MyId" $EsxUpgradeFailureAction = Initialize-VcfEsxUpgradeFailureAction -RetryDelay 0 -RetryCount 0 -Action "FAIL, RETRY" $EsxUpgradeOptionsSpec = Initialize-VcfEsxUpgradeOptionsSpec -EsxUpgradeFailureAction $EsxUpgradeFailureAction -EnforceHclValidation $false -EnableQuickPatch $false -EnableQuickboot $false -EvacuateOfflineVms $false -DisableHac $false -DisableDpm $false -PreRemediationPowerAction "POWER_OFF_VMS, SUSPEND_VMS, DO_NOT_CHANGE_VMS_POWER_STATE, SUSPEND_VMS_TO_MEMORY" $ResourceUpgradeSpec = Initialize-VcfResourceUpgradeSpec -ResourceId "MyResourceId" -ShutdownVms $false -ToVersion "MyToVersion" -ScheduledTimestamp "MyScheduledTimestamp" -UpgradeNow $false -PersonalitySpec $PersonalitySpec -CustomIsoSpec $CustomISOSpec -EnableQuickboot $false -EvacuateOfflineVms $false -EsxUpgradeOptionsSpec $EsxUpgradeOptionsSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceUpgradeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceUpgradeSpec = Initialize-VcfResourceUpgradeSpec -ResourceId "MyResourceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceUpgradeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourceUpgradeSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfPersonalitySpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfCustomISOSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEsxUpgradeOptionsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfResourceWarningCreationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceWarningCreationSpec</command:noun> <maml:description> <maml:para>Resource Warning creation specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resource Warning creation specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfResourceWarningCreationSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>ID of the resource to which this warning will be associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Name of the resource to which this warning will be associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Type of the resource to which this warning will be associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(ResourceTypeEnum)</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WarningType</maml:name> <maml:Description> <maml:para>The type of the warning</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(WarningTypeEnum)</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Severity</maml:name> <maml:Description> <maml:para>The severity of the warning</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(SeverityEnum)</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OccurredAtTimestamp</maml:name> <maml:Description> <maml:para>The Unix epoch timestamp of when the warning occurred</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Context</maml:name> <maml:Description> <maml:para>Optional additional context information to be associated to the warning</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalizableWarningPack</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LocalizableWarningPack</command:parameterValue> <dev:type> <maml:name>LocalizableWarningPack</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AssociatedTask</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AssociatedTask</command:parameterValue> <dev:type> <maml:name>AssociatedTask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>ID of the resource to which this warning will be associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceName</maml:name> <maml:Description> <maml:para>Name of the resource to which this warning will be associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Type of the resource to which this warning will be associated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(ResourceTypeEnum)</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WarningType</maml:name> <maml:Description> <maml:para>The type of the warning</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(WarningTypeEnum)</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Severity</maml:name> <maml:Description> <maml:para>The severity of the warning</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(SeverityEnum)</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OccurredAtTimestamp</maml:name> <maml:Description> <maml:para>The Unix epoch timestamp of when the warning occurred</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Context</maml:name> <maml:Description> <maml:para>Optional additional context information to be associated to the warning</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalizableWarningPack</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LocalizableWarningPack</command:parameterValue> <dev:type> <maml:name>LocalizableWarningPack</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AssociatedTask</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AssociatedTask</command:parameterValue> <dev:type> <maml:name>AssociatedTask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $LocalizableWarningPack = Initialize-VcfLocalizableWarningPack -WarningCode "MyWarningCode" -LocalBundle "MyLocalBundle" -VipComponent "MyVipComponent" -DefaultMessage "MyDefaultMessage" -Arguments "MyArguments" -ReferenceToken "MyReferenceToken" $AssociatedTask = Initialize-VcfAssociatedTask -TaskId "MyTaskId" -SubTaskId "MySubTaskId" $ResourceWarningCreationSpec = Initialize-VcfResourceWarningCreationSpec -ResourceId "MyResourceId" -ResourceName "MyResourceName" -ResourceType "HOST" -WarningType "CONFIGURATION" -Severity "MAJOR" -OccurredAtTimestamp 0 -Context @{ key_example = "MyInner" } -LocalizableWarningPack $LocalizableWarningPack -AssociatedTask $AssociatedTask </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceWarningCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $LocalizableWarningPack = Initialize-VcfLocalizableWarningPack -WarningCode "MyWarningCode" -LocalBundle "MyLocalBundle" -VipComponent "MyVipComponent" -DefaultMessage "MyDefaultMessage" $ResourceWarningCreationSpec = Initialize-VcfResourceWarningCreationSpec -ResourceId "MyResourceId" -ResourceName "MyResourceName" -ResourceType "HOST" -WarningType "CONFIGURATION" -Severity "MAJOR" -OccurredAtTimestamp 0 -LocalizableWarningPack $LocalizableWarningPack </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfResourceWarningCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/ResourceWarningCreationSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLocalizableWarningPack</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfAssociatedTask</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCreateResourceWarning</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCreateResourceWarning</command:noun> <maml:description> <maml:para>Create a new Resource Warning</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCreateResourceWarning</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceWarningCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceWarningCreationSpec</command:parameterValue> <dev:type> <maml:name>ResourceWarningCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceWarningCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResourceWarningCreationSpec</command:parameterValue> <dev:type> <maml:name>ResourceWarningCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ResourceWarning</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LocalizableWarningPack = Initialize-VcfLocalizableWarningPack -WarningCode "MyWarningCode" -LocalBundle "MyLocalBundle" -VipComponent "MyVipComponent" -DefaultMessage "MyDefaultMessage" -Arguments "MyArguments" -ReferenceToken "MyReferenceToken" $AssociatedTask = Initialize-VcfAssociatedTask -TaskId "MyTaskId" -SubTaskId "MySubTaskId" $ResourceWarningCreationSpec = Initialize-VcfResourceWarningCreationSpec -ResourceId "MyResourceId" -ResourceName "MyResourceName" -ResourceType "HOST" -WarningType "CONFIGURATION" -Severity "MAJOR" -OccurredAtTimestamp 0 -Context @{ key_example = "MyInner" } -LocalizableWarningPack $LocalizableWarningPack -AssociatedTask $AssociatedTask Invoke-VcfCreateResourceWarning -resourceWarningCreationSpec $resourceWarningCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateResourceWarning with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LocalizableWarningPack = Initialize-VcfLocalizableWarningPack -WarningCode "MyWarningCode" -LocalBundle "MyLocalBundle" -VipComponent "MyVipComponent" -DefaultMessage "MyDefaultMessage" $ResourceWarningCreationSpec = Initialize-VcfResourceWarningCreationSpec -ResourceId "MyResourceId" -ResourceName "MyResourceName" -ResourceType "HOST" -WarningType "CONFIGURATION" -Severity "MAJOR" -OccurredAtTimestamp 0 -LocalizableWarningPack $LocalizableWarningPack Invoke-VcfCreateResourceWarning -resourceWarningCreationSpec $resourceWarningCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateResourceWarning with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resource-warnings/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfResourceWarningCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetResourceWarning</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetResourceWarning</command:noun> <maml:description> <maml:para>Get a Resource Warning by ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetResourceWarning</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ResourceWarning</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourceWarning -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourceWarning with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourceWarning -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourceWarning with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resource-warnings/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetResourceWarnings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetResourceWarnings</command:noun> <maml:description> <maml:para>Get Resource Warnings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetResourceWarnings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Resource IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceNames</maml:name> <maml:Description> <maml:para>Resource Names</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Resource IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceNames</maml:name> <maml:Description> <maml:para>Resource Names</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfResourceWarning</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourceWarnings -resourceType "MyresourceType" -resourceIds "MyresourceIds" -resourceNames "MyresourceNames" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourceWarnings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetResourceWarnings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetResourceWarnings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/resource-warnings/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfRestoreSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>RestoreSpec</command:noun> <maml:description> <maml:para>Restore Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restore Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfRestoreSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>List of elements to be restored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BackupResource></command:parameterValue> <dev:type> <maml:name>List<BackupResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupFile</maml:name> <maml:Description> <maml:para>Backup file name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Encryption</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Encryption</command:parameterValue> <dev:type> <maml:name>Encryption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Elements</maml:name> <maml:Description> <maml:para>List of elements to be restored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BackupResource></command:parameterValue> <dev:type> <maml:name>List<BackupResource></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BackupFile</maml:name> <maml:Description> <maml:para>Backup file name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Encryption</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Encryption</command:parameterValue> <dev:type> <maml:name>Encryption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" $Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" $RestoreSpec = Initialize-VcfRestoreSpec -Elements $BackupResource -BackupFile "MyBackupFile" -Encryption $Encryption </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfRestoreSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BackupResource = Initialize-VcfBackupResource -ResourceType "SDDC_MANAGER" $Encryption = Initialize-VcfEncryption -Passphrase "MyPassphrase" $RestoreSpec = Initialize-VcfRestoreSpec -Elements $BackupResource -BackupFile "MyBackupFile" -Encryption $Encryption </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfRestoreSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/RestoreSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEncryption</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfRoleReference</command:name> <command:verb>Initialize</command:verb> <command:noun>RoleReference</command:noun> <maml:description> <maml:para>Represents a role reference</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a role reference</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfRoleReference</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the role</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the role</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$RoleReference = Initialize-VcfRoleReference -Id "MyId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfRoleReference with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RoleReference = Initialize-VcfRoleReference -Id "MyId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfRoleReference with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/RoleReference</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfRootCaCerts</command:name> <command:verb>Initialize</command:verb> <command:noun>RootCaCerts</command:noun> <maml:description> <maml:para>Spec contains Root Certificate Authority parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec contains Root Certificate Authority parameters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfRootCaCerts</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Alias</maml:name> <maml:Description> <maml:para>Certificate alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertChain</maml:name> <maml:Description> <maml:para>List of Base64 encoded certificates</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Alias</maml:name> <maml:Description> <maml:para>Certificate alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertChain</maml:name> <maml:Description> <maml:para>List of Base64 encoded certificates</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$RootCaCerts = Initialize-VcfRootCaCerts -Alias "MyAlias" -CertChain "MyCertChain" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfRootCaCerts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RootCaCerts = Initialize-VcfRootCaCerts </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfRootCaCerts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/RootCaCerts</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartBringupSpecConversion</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartBringupSpecConversion</command:noun> <maml:description> <maml:para>Convert SDDC specification Json/Excel File</maml:para> </maml:description> </command:details> <maml:description> <maml:para>SDDC specification incorporates all the client inputs regarding VMW component parameters constituting the SDDC: NTP, DNS spec, ESXi, VC, VSAN, NSX spec et al.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartBringupSpecConversion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SpecFile</maml:name> <maml:Description> <maml:para>SDDC specification file which is either a JSON or xls file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Design</maml:name> <maml:Description> <maml:para>Supported bringup designs - EMS, VXRAIL</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EMS</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SpecFile</maml:name> <maml:Description> <maml:para>SDDC specification file which is either a JSON or xls file</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileParameter</command:parameterValue> <dev:type> <maml:name>FileParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Design</maml:name> <maml:Description> <maml:para>Supported bringup designs - EMS, VXRAIL</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EMS</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SddcSpec</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfStartBringupSpecConversion -specFile -design "EMS" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartBringupSpecConversion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfStartBringupSpecConversion -specFile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartBringupSpecConversion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/sddc-spec-converter/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSddcHotPatchInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>SddcHotPatchInfo</command:noun> <maml:description> <maml:para>Sddc Hot patch info rest model that is located in the 2.0 manifest, as part of the async patch catalog.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sddc Hot patch info rest model that is located in the 2.0 manifest, as part of the async patch catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSddcHotPatchInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcHotPatchMinTargetVcfVersion</maml:name> <maml:Description> <maml:para>Sddc Hot patch min target version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcHotPatchMinTargetVcfVersion</maml:name> <maml:Description> <maml:para>Sddc Hot patch min target version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SddcHotPatchInfo = Initialize-VcfSddcHotPatchInfo -_Version "My_Version" -SddcHotPatchMinTargetVcfVersion "MySddcHotPatchMinTargetVcfVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcHotPatchInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SddcHotPatchInfo = Initialize-VcfSddcHotPatchInfo -_Version "My_Version" -SddcHotPatchMinTargetVcfVersion "MySddcHotPatchMinTargetVcfVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcHotPatchInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SddcHotPatchInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSddcManagerInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>SddcManagerInfo</command:noun> <maml:description> <maml:para>SDDC Manager Information</maml:para> </maml:description> </command:details> <maml:description> <maml:para>SDDC Manager Information</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSddcManagerInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>FQDN of the SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Version of the SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP Address of the SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>FQDN of the SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Version of the SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP Address of the SDDC Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SddcManagerInfo = Initialize-VcfSddcManagerInfo -Id "MyId" -Fqdn "MyFqdn" -_Version "My_Version" -IpAddress "MyIpAddress" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcManagerInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SddcManagerInfo = Initialize-VcfSddcManagerInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcManagerInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SddcManagerInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSddcManagerRelease</command:name> <command:verb>Initialize</command:verb> <command:noun>SddcManagerRelease</command:noun> <maml:description> <maml:para>Collection of Sddc Manager Releases</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Collection of Sddc Manager Releases</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSddcManagerRelease</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Sddc Manager release version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Sddc Manager release description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdditionalMetadata</maml:name> <maml:Description> <maml:para>Sddc Manager release additional details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>Bundle ID of the Sddc Manager release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>Sddc Manager version release date in epoch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CumulativeFromVcfVersion</maml:name> <maml:Description> <maml:para>Minimum VCF version that this patch bundle can be directly applied on</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Sddc Manager release version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Sddc Manager release description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdditionalMetadata</maml:name> <maml:Description> <maml:para>Sddc Manager release additional details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>Bundle ID of the Sddc Manager release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReleaseDate</maml:name> <maml:Description> <maml:para>Sddc Manager version release date in epoch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CumulativeFromVcfVersion</maml:name> <maml:Description> <maml:para>Minimum VCF version that this patch bundle can be directly applied on</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SddcManagerRelease = Initialize-VcfSddcManagerRelease -_Version "My_Version" -Description "MyDescription" -AdditionalMetadata "MyAdditionalMetadata" -BundleId "MyBundleId" -ReleaseDate 0 -CumulativeFromVcfVersion "MyCumulativeFromVcfVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcManagerRelease with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SddcManagerRelease = Initialize-VcfSddcManagerRelease -_Version "My_Version" -Description "MyDescription" -AdditionalMetadata "MyAdditionalMetadata" -BundleId "MyBundleId" -ReleaseDate 0 -CumulativeFromVcfVersion "MyCumulativeFromVcfVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcManagerRelease with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SddcManagerRelease</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetLocalOsUserAccounts</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetLocalOsUserAccounts</command:noun> <maml:description> <maml:para>Get local OS user accounts from the SDDC Manager appliance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a list of local OS user accounts from the SDDC Manager appliance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetLocalOsUserAccounts</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<LocalOsUserAccount></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetLocalOsUserAccounts </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLocalOsUserAccounts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetLocalOsUserAccounts </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLocalOsUserAccounts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sddc-manager/local-os-user-accounts/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSddcManager</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSddcManager</command:noun> <maml:description> <maml:para>Retrieve the details of an SDDC Manager by its id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSddcManager</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Sddc Manager ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Sddc Manager ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SddcManager</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcManager -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcManager with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcManager -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcManager with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sddc-managers/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSddcManagerHistory</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSddcManagerHistory</command:noun> <maml:description> <maml:para>Retrieve the history of SDDC Manager by its id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSddcManagerHistory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>SDDC Manager ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>SDDC Manager ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>History</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcManagerHistory -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcManagerHistory with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcManagerHistory -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcManagerHistory with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sddc-managers/id/history/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSddcManagers</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSddcManagers</command:noun> <maml:description> <maml:para>Retrieve a list of SDDC Managers</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSddcManagers</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfSddcManager</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcManagers </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcManagers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcManagers </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcManagers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sddc-managers/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSddcManagerUpgradables</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSddcManagerUpgradables</command:noun> <maml:description> <maml:para>Fetch SDDC Manager Upgradables</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSddcManagerUpgradables</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicabilityStatus</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Version</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicabilityStatus</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Version</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcManagerUpgradables -applicabilityStatus "APPLICABLE, NOT_APPLICABLE" -version 5.0.0.1,5.0.0.2 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcManagerUpgradables with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSddcManagerUpgradables </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSddcManagerUpgradables with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sddc-manager/upgradables/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSddcSubTask</command:name> <command:verb>Initialize</command:verb> <command:noun>SddcSubTask</command:noun> <maml:description> <maml:para>Represents a SDDC sub-task</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a SDDC sub-task</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSddcSubTask</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcId</maml:name> <maml:Description> <maml:para>SDDC ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProcessingStateName</maml:name> <maml:Description> <maml:para>Processing category name, e.g., VC Deployment, VSAN configuration etc</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProcessingStateDescription</maml:name> <maml:Description> <maml:para>Processing category description, e.g., VC Deployment, VSAN configuration etc</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Sub-Task Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Sub-Task Description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalizableNamePack</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MessagePack</command:parameterValue> <dev:type> <maml:name>MessagePack</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalizableDescriptionPack</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MessagePack</command:parameterValue> <dev:type> <maml:name>MessagePack</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Task Status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTimestamp</maml:name> <maml:Description> <maml:para>Sub-Task Creation Time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpdateTimestamp</maml:name> <maml:Description> <maml:para>Last Update Time of Sub-Task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Errors</maml:name> <maml:Description> <maml:para>List of errors in case of a failure</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Error></command:parameterValue> <dev:type> <maml:name>List<Error></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcId</maml:name> <maml:Description> <maml:para>SDDC ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProcessingStateName</maml:name> <maml:Description> <maml:para>Processing category name, e.g., VC Deployment, VSAN configuration etc</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProcessingStateDescription</maml:name> <maml:Description> <maml:para>Processing category description, e.g., VC Deployment, VSAN configuration etc</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Sub-Task Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Sub-Task Description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalizableNamePack</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MessagePack</command:parameterValue> <dev:type> <maml:name>MessagePack</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalizableDescriptionPack</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MessagePack</command:parameterValue> <dev:type> <maml:name>MessagePack</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Task Status</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTimestamp</maml:name> <maml:Description> <maml:para>Sub-Task Creation Time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpdateTimestamp</maml:name> <maml:Description> <maml:para>Last Update Time of Sub-Task</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Errors</maml:name> <maml:Description> <maml:para>List of errors in case of a failure</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Error></command:parameterValue> <dev:type> <maml:name>List<Error></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $SddcSubTask = Initialize-VcfSddcSubTask -SddcId "123e4567-e89b-42d3-a456-556642440000" -ProcessingStateName "MyProcessingStateName" -ProcessingStateDescription "MyProcessingStateDescription" -Name "MyName" -Description "MyDescription" -LocalizableNamePack $MessagePack -LocalizableDescriptionPack $MessagePack -Status "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR" -CreationTimestamp "MyCreationTimestamp" -UpdateTimestamp "MyUpdateTimestamp" -Errors $Error </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcSubTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SddcSubTask = Initialize-VcfSddcSubTask </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcSubTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SddcSubTask</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-Vcf</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-Vcf</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSddcTask</command:name> <command:verb>Initialize</command:verb> <command:noun>SddcTask</command:noun> <maml:description> <maml:para>Represents a SDDC task</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a SDDC task</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSddcTask</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>SDDC ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Task name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>SDDC Task status. One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalizableNamePack</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MessagePack</command:parameterValue> <dev:type> <maml:name>MessagePack</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTimestamp</maml:name> <maml:Description> <maml:para>SDDC Task creation timestamp</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcSubTasks</maml:name> <maml:Description> <maml:para>All SDDC Sub-Tasks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SddcSubTask></command:parameterValue> <dev:type> <maml:name>List<SddcSubTask></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>SDDC ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Task name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>SDDC Task status. One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalizableNamePack</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MessagePack</command:parameterValue> <dev:type> <maml:name>MessagePack</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTimestamp</maml:name> <maml:Description> <maml:para>SDDC Task creation timestamp</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SddcSubTasks</maml:name> <maml:Description> <maml:para>All SDDC Sub-Tasks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SddcSubTask></command:parameterValue> <dev:type> <maml:name>List<SddcSubTask></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ErrorCause = Initialize-VcfErrorCause -Type "MyType" -Message "MyMessage" $Error = Initialize-VcfError -ErrorCode "MyErrorCode" -ErrorType "MyErrorType" -Arguments "MyArguments" -Context @{ key_example = "MyInner" } -Message "MyMessage" -RemediationMessage "MyRemediationMessage" -Causes $ErrorCause -NestedErrors $Error -ReferenceToken "MyReferenceToken" $SddcSubTask = Initialize-VcfSddcSubTask -SddcId "123e4567-e89b-42d3-a456-556642440000" -ProcessingStateName "MyProcessingStateName" -ProcessingStateDescription "MyProcessingStateDescription" -Name "MyName" -Description "MyDescription" -LocalizableNamePack $MessagePack -LocalizableDescriptionPack $MessagePack -Status "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR" -CreationTimestamp "MyCreationTimestamp" -UpdateTimestamp "MyUpdateTimestamp" -Errors $Error $SddcTask = Initialize-VcfSddcTask -Id "MyId" -Name "MyName" -Status "COMPLETED_WITH_SUCCESS" -LocalizableNamePack $MessagePack -CreationTimestamp "MyCreationTimestamp" -SddcSubTasks $SddcSubTask </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SddcTask = Initialize-VcfSddcTask -Status "COMPLETED_WITH_SUCCESS" -CreationTimestamp "MyCreationTimestamp" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSddcTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SddcTask</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-Vcf</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSecuritySpec</command:name> <command:verb>Initialize</command:verb> <command:noun>SecuritySpec</command:noun> <maml:description> <maml:para>Spec contains security settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec contains security settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSecuritySpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsxiCertsMode</maml:name> <maml:Description> <maml:para>ESXi certificates mode. One among:Custom, VMCA</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RootCaCerts</maml:name> <maml:Description> <maml:para>Root Certificate Authority certificate list</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<RootCaCerts></command:parameterValue> <dev:type> <maml:name>List<RootCaCerts></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsxiCertsMode</maml:name> <maml:Description> <maml:para>ESXi certificates mode. One among:Custom, VMCA</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RootCaCerts</maml:name> <maml:Description> <maml:para>Root Certificate Authority certificate list</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<RootCaCerts></command:parameterValue> <dev:type> <maml:name>List<RootCaCerts></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $RootCaCerts = Initialize-VcfRootCaCerts -Alias "MyAlias" -CertChain "MyCertChain" $SecuritySpec = Initialize-VcfSecuritySpec -EsxiCertsMode "VMCA" -RootCaCerts $RootCaCerts </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSecuritySpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SecuritySpec = Initialize-VcfSecuritySpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSecuritySpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SecuritySpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSelectedCheckSetCandidate</command:name> <command:verb>Initialize</command:verb> <command:noun>SelectedCheckSetCandidate</command:noun> <maml:description> <maml:para>Selected check-set candidate</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Selected check-set candidate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSelectedCheckSetCandidate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSetId</maml:name> <maml:Description> <maml:para>Id of the selected check-set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckSetId</maml:name> <maml:Description> <maml:para>Id of the selected check-set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SelectedCheckSetCandidate = Initialize-VcfSelectedCheckSetCandidate -CheckSetId "MyCheckSetId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSelectedCheckSetCandidate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SelectedCheckSetCandidate = Initialize-VcfSelectedCheckSetCandidate -CheckSetId "MyCheckSetId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSelectedCheckSetCandidate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SelectedCheckSetCandidate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSharesInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>SharesInfo</command:noun> <maml:description> <maml:para>Specify relative allocation between resource consumers</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Specify relative allocation between resource consumers</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSharesInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Shares</maml:name> <maml:Description> <maml:para>The number of shares allocated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>The allocation level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Shares</maml:name> <maml:Description> <maml:para>The number of shares allocated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>The allocation level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSharesInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SharesInfo = Initialize-VcfSharesInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSharesInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SharesInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSkuBomDetails</command:name> <command:verb>Initialize</command:verb> <command:noun>SkuBomDetails</command:noun> <maml:description> <maml:para>Model for sku with their name, description, patchBundles and bom</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model for sku with their name, description, patchBundles and bom</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSkuBomDetails</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>SKU name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description to be shown in release page</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkuSpecificPatchBundles</maml:name> <maml:Description> <maml:para>List of patch bundles in this release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SkuSpecificPatchBundles></command:parameterValue> <dev:type> <maml:name>List<SkuSpecificPatchBundles></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Bom</maml:name> <maml:Description> <maml:para>Sku specific bill of materials</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ProductVersion></command:parameterValue> <dev:type> <maml:name>List<ProductVersion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>SKU name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description to be shown in release page</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkuSpecificPatchBundles</maml:name> <maml:Description> <maml:para>List of patch bundles in this release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SkuSpecificPatchBundles></command:parameterValue> <dev:type> <maml:name>List<SkuSpecificPatchBundles></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Bom</maml:name> <maml:Description> <maml:para>Sku specific bill of materials</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ProductVersion></command:parameterValue> <dev:type> <maml:name>List<ProductVersion></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $SkuSpecificPatchBundles = Initialize-VcfSkuSpecificPatchBundles -BundleType "MyBundleType" -BundleVersion "MyBundleVersion" -_Version "My_Version" $ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" -ReleaseURL "MyReleaseURL" -AdditionalMetadata "MyAdditionalMetadata" $SkuBomDetails = Initialize-VcfSkuBomDetails -Name "MyName" -Description "MyDescription" -SkuSpecificPatchBundles $SkuSpecificPatchBundles -Bom $ProductVersion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSkuBomDetails with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ProductVersion = Initialize-VcfProductVersion -Name "MyName" -_Version "My_Version" -PublicName "MyPublicName" $SkuBomDetails = Initialize-VcfSkuBomDetails -Bom $ProductVersion </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSkuBomDetails with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SkuBomDetails</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSkuSpecificPatchBundles</command:name> <command:verb>Initialize</command:verb> <command:noun>SkuSpecificPatchBundles</command:noun> <maml:description> <maml:para>Model for Sku specific patch bundle in a release</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model for Sku specific patch bundle in a release</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSkuSpecificPatchBundles</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleType</maml:name> <maml:Description> <maml:para>Bundle type of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleVersion</maml:name> <maml:Description> <maml:para>Bundle Version of the product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleType</maml:name> <maml:Description> <maml:para>Bundle type of the patch bundle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleVersion</maml:name> <maml:Description> <maml:para>Bundle Version of the product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SkuSpecificPatchBundles = Initialize-VcfSkuSpecificPatchBundles -BundleType "MyBundleType" -BundleVersion "MyBundleVersion" -_Version "My_Version" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSkuSpecificPatchBundles with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SkuSpecificPatchBundles = Initialize-VcfSkuSpecificPatchBundles -BundleType "MyBundleType" -BundleVersion "MyBundleVersion" -_Version "My_Version" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSkuSpecificPatchBundles with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SkuSpecificPatchBundles</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSoftwareInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>SoftwareInfo</command:noun> <maml:description> <maml:para>SoftwareSpec contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>SoftwareSpec contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSoftwareInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseImage</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BaseImageInfo</command:parameterValue> <dev:type> <maml:name>BaseImageInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AddOn</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AddOnInfo</command:parameterValue> <dev:type> <maml:name>AddOnInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Components</maml:name> <maml:Description> <maml:para>Personality components</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, ComponentInfo></command:parameterValue> <dev:type> <maml:name>Dictionary<string, ComponentInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HardwareSupport</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HardwareSupportInfo</command:parameterValue> <dev:type> <maml:name>HardwareSupportInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseImage</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BaseImageInfo</command:parameterValue> <dev:type> <maml:name>BaseImageInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AddOn</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AddOnInfo</command:parameterValue> <dev:type> <maml:name>AddOnInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Components</maml:name> <maml:Description> <maml:para>Personality components</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, ComponentInfo></command:parameterValue> <dev:type> <maml:name>Dictionary<string, ComponentInfo></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HardwareSupport</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HardwareSupportInfo</command:parameterValue> <dev:type> <maml:name>HardwareSupportInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ModelVersion = Initialize-VcfModelVersion -_Version "8.0.3-0.0.23174786" -DisplayVersion "8.0 Update 3 - 23174786" $BaseImageDetails = Initialize-VcfBaseImageDetails -DisplayName "7.0.0-0.0.30340198" -DisplayVersion "MyDisplayVersion" -ReleaseDate "MyReleaseDate" -ReleaseTimestamp "MyReleaseTimestamp" -QuickPatchCompatibleVersions $ModelVersion $BaseImageInfo = Initialize-VcfBaseImageInfo -_Version "7.0.0-0.0.30340198" -Details $BaseImageDetails $AddOnInfo = Initialize-VcfAddOnInfo -_Version "2.0-1" -Name "DELL-sample-Addon" -Vendor "Dell" -DisplayName "MyDisplayName" -DisplayVersion "MyDisplayVersion" $ComponentDetails = Initialize-VcfComponentDetails -Vendor "intel" -DisplayName "MyDisplayName" -DisplayVersion "MyDisplayVersion" $ComponentInfo = Initialize-VcfComponentInfo -_Version "1.3.2.8-1OEM.650.0.0.4598673" -Details $ComponentDetails $HardwareSupportPackageInfo = Initialize-VcfHardwareSupportPackageInfo -Pkg "MyPkg" -_Version "My_Version" $HardwareSupportInfo = Initialize-VcfHardwareSupportInfo -Packages @{ key_example = $HardwareSupportPackageInfo } $SoftwareInfo = Initialize-VcfSoftwareInfo -BaseImage $BaseImageInfo -AddOn $AddOnInfo -Components @{ key_example = $ComponentInfo } -HardwareSupport $HardwareSupportInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSoftwareInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BaseImageInfo = Initialize-VcfBaseImageInfo -_Version "7.0.0-0.0.30340198" $SoftwareInfo = Initialize-VcfSoftwareInfo -BaseImage $BaseImageInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSoftwareInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SoftwareInfo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfBaseImageInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfAddOnInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHardwareSupportInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfExportHealthCheckByID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfExportHealthCheckByID</command:noun> <maml:description> <maml:para>Download a Health Check tar.gz by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfExportHealthCheckByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Health Summary Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Health Summary Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>byte[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfExportHealthCheckByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfExportHealthCheckByID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfExportHealthCheckByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfExportHealthCheckByID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/health-summary/id/data/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfExportSupportBundleByID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfExportSupportBundleByID</command:noun> <maml:description> <maml:para>Download a Support Bundle tar.gz by ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfExportSupportBundleByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Support Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Support Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>byte[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfExportSupportBundleByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfExportSupportBundleByID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfExportSupportBundleByID -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfExportSupportBundleByID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/support-bundles/id/data/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHealthCheckStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHealthCheckStatus</command:noun> <maml:description> <maml:para>Retrieve the status of the Health Check operations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHealthCheckStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Health Summary Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Health Summary Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HealthSummary</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHealthCheckStatus -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHealthCheckStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHealthCheckStatus -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHealthCheckStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/health-summary/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetHealthCheckTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetHealthCheckTask</command:noun> <maml:description> <maml:para>Retieve a list of Health Check tasks</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetHealthCheckTask</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfHealthSummary</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetHealthCheckTask </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHealthCheckTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetHealthCheckTask </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetHealthCheckTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/health-summary/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSupportBundleStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSupportBundleStatus</command:noun> <maml:description> <maml:para>Retrive the status of the Support Bundle operation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSupportBundleStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Support Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Support Bundle ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SupportBundle</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSupportBundleStatus -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSupportBundleStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSupportBundleStatus -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSupportBundleStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/support-bundles/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSupportBundleTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSupportBundleTask</command:noun> <maml:description> <maml:para>Retrieve a list of Support Bundle tasks</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSupportBundleTask</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfSupportBundle</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSupportBundleTask </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSupportBundleTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSupportBundleTask </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSupportBundleTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/support-bundles/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartHealthCheck</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartHealthCheck</command:noun> <maml:description> <maml:para>Start a Health Check operation using SoS</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartHealthCheck</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HealthSummarySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummarySpec</command:parameterValue> <dev:type> <maml:name>HealthSummarySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HealthSummarySpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HealthSummarySpec</command:parameterValue> <dev:type> <maml:name>HealthSummarySpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HealthSummary</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HealthSummaryConfig = Initialize-VcfHealthSummaryConfig -SkipKnownHostCheck $false -Force $false $HealthSummaryIncludeItems = Initialize-VcfHealthSummaryIncludeItems -SummaryReport $false -PrecheckReport $false $HealthSummaryOption = Initialize-VcfHealthSummaryOption -Config $HealthSummaryConfig -Include $HealthSummaryIncludeItems $Domains = Initialize-VcfDomains -DomainName "MyDomainName" -ClusterNames "MyClusterNames" $HealthSummaryScope = Initialize-VcfHealthSummaryScope -IncludeFreeHosts $false -IncludeAllDomains $false -Domains $Domains $HealthChecks = Initialize-VcfHealthChecks -ServicesHealth $false -NtpHealth $false -GeneralHealth $false -CertificateHealth $false -PasswordHealth $false -ConnectivityHealth $false -ComputeHealth $false -StorageHealth $false -DnsHealth $false -HardwareCompatibilityHealth $false -VersionHealth $false $HealthSummarySpec = Initialize-VcfHealthSummarySpec -Options $HealthSummaryOption -Scope $HealthSummaryScope -HealthChecks $HealthChecks Invoke-VcfStartHealthCheck -healthSummarySpec $healthSummarySpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartHealthCheck with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HealthSummarySpec = Initialize-VcfHealthSummarySpec Invoke-VcfStartHealthCheck -healthSummarySpec $healthSummarySpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartHealthCheck with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/health-summary/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfHealthSummarySpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartSupportBundle</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartSupportBundle</command:noun> <maml:description> <maml:para>Start a Support Bundle operation using SoS</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartSupportBundle</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SupportBundleSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleSpec</command:parameterValue> <dev:type> <maml:name>SupportBundleSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SupportBundleSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleSpec</command:parameterValue> <dev:type> <maml:name>SupportBundleSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SupportBundle</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SupportBundleConfig = Initialize-VcfSupportBundleConfig -SkipKnownHostCheck $false -Force $false $SupportBundleIncludeItems = Initialize-VcfSupportBundleIncludeItems -SummaryReport $false -HealthCheck $false $SupportBundleOption = Initialize-VcfSupportBundleOption -Config $SupportBundleConfig -Include $SupportBundleIncludeItems $Domains = Initialize-VcfDomains -DomainName "MyDomainName" -ClusterNames "MyClusterNames" $SupportBundleScope = Initialize-VcfSupportBundleScope -IncludeFreeHosts $false -Domains $Domains $Logs = Initialize-VcfLogs -VcLogs $false -NsxLogs $false -EsxLogs $false -WcpLogs $false -SddcManagerLogs $false -ApiLogs $false -VxrailManagerLogs $false -SystemDebugLogs $false -VmScreenshots $false -VraLogs $false -VropsLogs $false -VrliLogs $false -VrslcmLogs $false -AutomationLogs $false -OperationsLogs $false -OperationsForLogs $false -LifecycleLogs $false $SupportBundleSpec = Initialize-VcfSupportBundleSpec -Options $SupportBundleOption -Scope $SupportBundleScope -Logs $Logs Invoke-VcfStartSupportBundle -supportBundleSpec $supportBundleSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartSupportBundle with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SupportBundleSpec = Initialize-VcfSupportBundleSpec Invoke-VcfStartSupportBundle -supportBundleSpec $supportBundleSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartSupportBundle with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/support-bundles/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSupportBundleSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSourceDetails</command:name> <command:verb>Initialize</command:verb> <command:noun>SourceDetails</command:noun> <maml:description> <maml:para>Details of the Identity Source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Details of the Identity Source</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSourceDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UsersBaseDn</maml:name> <maml:Description> <maml:para>Base distinguished name for users</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupsBaseDn</maml:name> <maml:Description> <maml:para>Base distinguished name for groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertChain</maml:name> <maml:Description> <maml:para>SSL certificate chain in base64 encoding. This field can be unset only, if all the active directory server endpoints use the LDAP (not LDAPS) protocol</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServerEndpoints</maml:name> <maml:Description> <maml:para>Active directory server endpoints. At least one active directory server endpoint must be set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UsersBaseDn</maml:name> <maml:Description> <maml:para>Base distinguished name for users</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupsBaseDn</maml:name> <maml:Description> <maml:para>Base distinguished name for groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertChain</maml:name> <maml:Description> <maml:para>SSL certificate chain in base64 encoding. This field can be unset only, if all the active directory server endpoints use the LDAP (not LDAPS) protocol</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServerEndpoints</maml:name> <maml:Description> <maml:para>Active directory server endpoints. At least one active directory server endpoint must be set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -CertChain "MyCertChain" -ServerEndpoints "MyServerEndpoints" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSourceDetails with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SourceDetails = Initialize-VcfSourceDetails -UsersBaseDn "MyUsersBaseDn" -GroupsBaseDn "MyGroupsBaseDn" -ServerEndpoints "MyServerEndpoints" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSourceDetails with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SourceDetails</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSsoDomainSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>SsoDomainSpec</command:noun> <maml:description> <maml:para>Spec for the SSO configuration in a VMware Cloud Foundation Domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec for the SSO configuration in a VMware Cloud Foundation Domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSsoDomainSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomainPassword</maml:name> <maml:Description> <maml:para>New SSO domain password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomainName</maml:name> <maml:Description> <maml:para>SSO domain name to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomainPassword</maml:name> <maml:Description> <maml:para>New SSO domain password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomainName</maml:name> <maml:Description> <maml:para>SSO domain name to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SsoDomainSpec = Initialize-VcfSsoDomainSpec -SsoDomainPassword "MySsoDomainPassword" -SsoDomainName "MySsoDomainName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSsoDomainSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SsoDomainSpec = Initialize-VcfSsoDomainSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSsoDomainSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SsoDomainSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfStorageContainer</command:name> <command:verb>Initialize</command:verb> <command:noun>StorageContainer</command:noun> <maml:description> <maml:para>Storage container representation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Storage container representation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfStorageContainer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProtocolType</maml:name> <maml:Description> <maml:para>Storage protocol type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>ID of the cluster which is using the storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProtocolType</maml:name> <maml:Description> <maml:para>Storage protocol type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>ID of the cluster which is using the storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StorageContainer = Initialize-VcfStorageContainer -Id "MyId" -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" -ClusterId "MyClusterId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfStorageContainer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StorageContainer = Initialize-VcfStorageContainer -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfStorageContainer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/StorageContainer</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfStorageContainerUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>StorageContainerUpdateSpec</command:noun> <maml:description> <maml:para>Storage container update data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Storage container update data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfStorageContainerUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StorageContainerUpdateSpec = Initialize-VcfStorageContainerUpdateSpec -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfStorageContainerUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StorageContainerUpdateSpec = Initialize-VcfStorageContainerUpdateSpec -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfStorageContainerUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/StorageContainerUpdateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfStretchClusterNetworkProfile</command:name> <command:verb>Initialize</command:verb> <command:noun>StretchClusterNetworkProfile</command:noun> <maml:description> <maml:para>This specification contains the host switch configurations for the NSX transport nodes belonging to Secondary AZ.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the host switch configurations for the NSX transport nodes belonging to Secondary AZ.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfStretchClusterNetworkProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The network profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The network profile description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtHostSwitchConfigs</maml:name> <maml:Description> <maml:para>The list of NSX host switch configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtHostSwitchConfig></command:parameterValue> <dev:type> <maml:name>List<NsxtHostSwitchConfig></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The network profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The network profile description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtHostSwitchConfigs</maml:name> <maml:Description> <maml:para>The list of NSX host switch configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtHostSwitchConfig></command:parameterValue> <dev:type> <maml:name>List<NsxtHostSwitchConfig></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -IpAddressPoolName "MyIpAddressPoolName" -VdsUplinkToNsxUplink $UplinkMapping $StretchClusterNetworkProfile = Initialize-VcfStretchClusterNetworkProfile -Name "MyName" -Description "MyDescription" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfStretchClusterNetworkProfile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" $NsxtHostSwitchConfig = Initialize-VcfNsxtHostSwitchConfig -VdsName "MyVdsName" -UplinkProfileName "MyUplinkProfileName" -VdsUplinkToNsxUplink $UplinkMapping $StretchClusterNetworkProfile = Initialize-VcfStretchClusterNetworkProfile -Name "MyName" -NsxtHostSwitchConfigs $NsxtHostSwitchConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfStretchClusterNetworkProfile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/StretchClusterNetworkProfile</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeployVrslcm</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeployVrslcm</command:noun> <maml:description> <maml:para>Deploy VMware Aria Suite Lifecycle</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Triggers the VMware Aria Suite Lifecycle deployment operation and returns an URL in the headers to track the operation status.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeployVrslcm</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrslcmDeploymentSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VrslcmDeploymentSpec</command:parameterValue> <dev:type> <maml:name>VrslcmDeploymentSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrslcmDeploymentSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VrslcmDeploymentSpec</command:parameterValue> <dev:type> <maml:name>VrslcmDeploymentSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VrslcmDeploymentSpec = Initialize-VcfVrslcmDeploymentSpec -Fqdn "vrslcm.vrack.vsphere.local" -SshPassword "MySshPassword" -ApiPassword "MyApiPassword" -NsxtStandaloneTier1Ip "MyNsxtStandaloneTier1Ip" Invoke-VcfDeployVrslcm -vrslcmDeploymentSpec $vrslcmDeploymentSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeployVrslcm with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VrslcmDeploymentSpec = Initialize-VcfVrslcmDeploymentSpec -Fqdn "vrslcm.vrack.vsphere.local" -SshPassword "MySshPassword" -ApiPassword "MyApiPassword" -NsxtStandaloneTier1Ip "MyNsxtStandaloneTier1Ip" Invoke-VcfDeployVrslcm -vrslcmDeploymentSpec $vrslcmDeploymentSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeployVrslcm with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrslcms/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVrslcmDeploymentSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVrslcm</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVrslcm</command:noun> <maml:description> <maml:para>Retrieve information about VMware Aria Suite Lifecycle</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the complete information about the existing VMware Aria Suite Lifecycle instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVrslcm</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Vrslcm</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrslcm </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrslcm with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrslcm </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrslcm with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrslcm/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVrslcmStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVrslcmStatus</command:noun> <maml:description> <maml:para>Retrieve information about VMware Aria Suite Lifecycle actual status</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get status on the VMware Aria Suite Lifecycle product and availability of different actions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVrslcmStatus</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VrslcmStatus</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrslcmStatus </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrslcmStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrslcmStatus </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrslcmStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrslcm/status/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVrslcmValidation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVrslcmValidation</command:noun> <maml:description> <maml:para>Retrieve the results of a VMware Aria Suite Lifecycle validation by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the status of given VMware Aria Suite Lifecycle validation workflow by given validation id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVrslcmValidation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VMware Aria validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VMware Aria validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrslcmValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrslcmValidation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrslcmValidation -id 38400000-8cf0-11bd-b23e-10b96e4ef00d </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrslcmValidation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrslcms/validations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVrslcms</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVrslcms</command:noun> <maml:description> <maml:para>Get all existing VMware Aria Suite Lifecycle instances</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVrslcms</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVrslcm</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrslcms </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrslcms with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVrslcms </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVrslcms with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrslcms/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRollbackVrslcm</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRollbackVrslcm</command:noun> <maml:description> <maml:para>Remove VMware Aria Suite Lifecycle after an unsuccessful deployment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Triggers the VMware Aria Suite Lifecycle rollback operation and returns an URL in the headers to track the operation status.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRollbackVrslcm</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRollbackVrslcm </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRollbackVrslcm with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRollbackVrslcm </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRollbackVrslcm with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrslcm/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateVrslcmVersionByIdInInventory</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateVrslcmVersionByIdInInventory</command:noun> <maml:description> <maml:para>Update the version of VMware Aria Suite Lifecycle based on its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates VMware Aria Suite Lifecycle version</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateVrslcmVersionByIdInInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>the ID of VMware Aria Suite Lifecycle instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vrslcm</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Vrslcm</command:parameterValue> <dev:type> <maml:name>Vrslcm</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>the ID of VMware Aria Suite Lifecycle instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vrslcm</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Vrslcm</command:parameterValue> <dev:type> <maml:name>Vrslcm</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Vrslcm = Initialize-VcfVrslcm -Id "MyId" -Fqdn "MyFqdn" -IpAddress "MyIpAddress" -_Version "My_Version" -Status "MyStatus" Invoke-VcfUpdateVrslcmVersionByIdInInventory -id "Myid" -vrslcm $vrslcm </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVrslcmVersionByIdInInventory with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Vrslcm = Initialize-VcfVrslcm -Id "MyId" -Fqdn "MyFqdn" -IpAddress "MyIpAddress" -_Version "My_Version" -Status "MyStatus" Invoke-VcfUpdateVrslcmVersionByIdInInventory -id "Myid" -vrslcm $vrslcm </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVrslcmVersionByIdInInventory with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrslcms/id/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVrslcm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateVrslcmVersionInInventory</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateVrslcmVersionInInventory</command:noun> <maml:description> <maml:para>Update the version of VMware Aria Suite Lifecycle</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates VMware Aria Suite Lifecycle version in VCF inventory</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateVrslcmVersionInInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vrslcm</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Vrslcm</command:parameterValue> <dev:type> <maml:name>Vrslcm</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Vrslcm</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Vrslcm</command:parameterValue> <dev:type> <maml:name>Vrslcm</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Vrslcm = Initialize-VcfVrslcm -Id "MyId" -Fqdn "MyFqdn" -IpAddress "MyIpAddress" -_Version "My_Version" -Status "MyStatus" Invoke-VcfUpdateVrslcmVersionInInventory -vrslcm $vrslcm </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVrslcmVersionInInventory with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Vrslcm = Initialize-VcfVrslcm -Id "MyId" -Fqdn "MyFqdn" -IpAddress "MyIpAddress" -_Version "My_Version" -Status "MyStatus" Invoke-VcfUpdateVrslcmVersionInInventory -vrslcm $vrslcm </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVrslcmVersionInInventory with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrslcm/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVrslcm</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateVrslcm</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateVrslcm</command:noun> <maml:description> <maml:para>Perform validation of the VrslcmDeploymentSpec specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Triggers VMware Aria Suite Lifecycle deployment specification validation workflow</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateVrslcm</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrslcmDeploymentSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VrslcmDeploymentSpec</command:parameterValue> <dev:type> <maml:name>VrslcmDeploymentSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrslcmDeploymentSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VrslcmDeploymentSpec</command:parameterValue> <dev:type> <maml:name>VrslcmDeploymentSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VrslcmDeploymentSpec = Initialize-VcfVrslcmDeploymentSpec -Fqdn "vrslcm.vrack.vsphere.local" -SshPassword "MySshPassword" -ApiPassword "MyApiPassword" -NsxtStandaloneTier1Ip "MyNsxtStandaloneTier1Ip" Invoke-VcfValidateVrslcm -vrslcmDeploymentSpec $vrslcmDeploymentSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateVrslcm with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VrslcmDeploymentSpec = Initialize-VcfVrslcmDeploymentSpec -Fqdn "vrslcm.vrack.vsphere.local" -SshPassword "MySshPassword" -ApiPassword "MyApiPassword" -NsxtStandaloneTier1Ip "MyNsxtStandaloneTier1Ip" Invoke-VcfValidateVrslcm -vrslcmDeploymentSpec $vrslcmDeploymentSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateVrslcm with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vrslcms/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVrslcmDeploymentSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSupportBundleConfig</command:name> <command:verb>Initialize</command:verb> <command:noun>SupportBundleConfig</command:noun> <maml:description> <maml:para>SupportBundle config.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>SupportBundle config.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSupportBundleConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipKnownHostCheck</maml:name> <maml:Description> <maml:para>Skip known_hosts file for SupportBundle collection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Run SOS operations, even if there is a Workload running.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SkipKnownHostCheck</maml:name> <maml:Description> <maml:para>Skip known_hosts file for SupportBundle collection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Run SOS operations, even if there is a Workload running.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SupportBundleConfig = Initialize-VcfSupportBundleConfig -SkipKnownHostCheck $false -Force $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleConfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SupportBundleConfig = Initialize-VcfSupportBundleConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleConfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SupportBundleConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSupportBundleIncludeItems</command:name> <command:verb>Initialize</command:verb> <command:noun>SupportBundleIncludeItems</command:noun> <maml:description> <maml:para>Sos Additional Reports for Support Bundle.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sos Additional Reports for Support Bundle.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSupportBundleIncludeItems</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SummaryReport</maml:name> <maml:Description> <maml:para>Collect Vcf Summary Reports.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HealthCheck</maml:name> <maml:Description> <maml:para>Perform SOS Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SummaryReport</maml:name> <maml:Description> <maml:para>Collect Vcf Summary Reports.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HealthCheck</maml:name> <maml:Description> <maml:para>Perform SOS Health checks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SupportBundleIncludeItems = Initialize-VcfSupportBundleIncludeItems -SummaryReport $false -HealthCheck $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleIncludeItems with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SupportBundleIncludeItems = Initialize-VcfSupportBundleIncludeItems </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleIncludeItems with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SupportBundleIncludeItems</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSupportBundleOption</command:name> <command:verb>Initialize</command:verb> <command:noun>SupportBundleOption</command:noun> <maml:description> <maml:para>Sos options for support bundle collection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sos options for support bundle collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSupportBundleOption</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Config</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleConfig</command:parameterValue> <dev:type> <maml:name>SupportBundleConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleIncludeItems</command:parameterValue> <dev:type> <maml:name>SupportBundleIncludeItems</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Config</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleConfig</command:parameterValue> <dev:type> <maml:name>SupportBundleConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleIncludeItems</command:parameterValue> <dev:type> <maml:name>SupportBundleIncludeItems</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $SupportBundleConfig = Initialize-VcfSupportBundleConfig -SkipKnownHostCheck $false -Force $false $SupportBundleIncludeItems = Initialize-VcfSupportBundleIncludeItems -SummaryReport $false -HealthCheck $false $SupportBundleOption = Initialize-VcfSupportBundleOption -Config $SupportBundleConfig -Include $SupportBundleIncludeItems </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleOption with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SupportBundleOption = Initialize-VcfSupportBundleOption </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleOption with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SupportBundleOption</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSupportBundleConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSupportBundleIncludeItems</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSupportBundleScope</command:name> <command:verb>Initialize</command:verb> <command:noun>SupportBundleScope</command:noun> <maml:description> <maml:para>Domain and cluster under which logs should be collected.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Domain and cluster under which logs should be collected.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSupportBundleScope</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeFreeHosts</maml:name> <maml:Description> <maml:para>Include free hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domains</maml:name> <maml:Description> <maml:para>Domains and Clusters for SOS operation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Domains></command:parameterValue> <dev:type> <maml:name>List<Domains></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeFreeHosts</maml:name> <maml:Description> <maml:para>Include free hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domains</maml:name> <maml:Description> <maml:para>Domains and Clusters for SOS operation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Domains></command:parameterValue> <dev:type> <maml:name>List<Domains></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Domains = Initialize-VcfDomains -DomainName "MyDomainName" -ClusterNames "MyClusterNames" $SupportBundleScope = Initialize-VcfSupportBundleScope -IncludeFreeHosts $false -Domains $Domains </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleScope with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SupportBundleScope = Initialize-VcfSupportBundleScope </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleScope with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SupportBundleScope</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSupportBundleSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>SupportBundleSpec</command:noun> <maml:description> <maml:para>No description available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSupportBundleSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Options</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleOption</command:parameterValue> <dev:type> <maml:name>SupportBundleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleScope</command:parameterValue> <dev:type> <maml:name>SupportBundleScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Logs</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Logs</command:parameterValue> <dev:type> <maml:name>Logs</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Options</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleOption</command:parameterValue> <dev:type> <maml:name>SupportBundleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SupportBundleScope</command:parameterValue> <dev:type> <maml:name>SupportBundleScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Logs</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Logs</command:parameterValue> <dev:type> <maml:name>Logs</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $SupportBundleConfig = Initialize-VcfSupportBundleConfig -SkipKnownHostCheck $false -Force $false $SupportBundleIncludeItems = Initialize-VcfSupportBundleIncludeItems -SummaryReport $false -HealthCheck $false $SupportBundleOption = Initialize-VcfSupportBundleOption -Config $SupportBundleConfig -Include $SupportBundleIncludeItems $Domains = Initialize-VcfDomains -DomainName "MyDomainName" -ClusterNames "MyClusterNames" $SupportBundleScope = Initialize-VcfSupportBundleScope -IncludeFreeHosts $false -Domains $Domains $Logs = Initialize-VcfLogs -VcLogs $false -NsxLogs $false -EsxLogs $false -WcpLogs $false -SddcManagerLogs $false -ApiLogs $false -VxrailManagerLogs $false -SystemDebugLogs $false -VmScreenshots $false -VraLogs $false -VropsLogs $false -VrliLogs $false -VrslcmLogs $false -AutomationLogs $false -OperationsLogs $false -OperationsForLogs $false -LifecycleLogs $false $SupportBundleSpec = Initialize-VcfSupportBundleSpec -Options $SupportBundleOption -Scope $SupportBundleScope -Logs $Logs </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SupportBundleSpec = Initialize-VcfSupportBundleSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSupportBundleSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SupportBundleSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSupportBundleOption</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSupportBundleScope</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLogs</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSystemConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSystemConfiguration</command:noun> <maml:description> <maml:para>Retrieve the system configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the system configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSystemConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSystemConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSystemConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSystemConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSystemConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateSystemConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateSystemConfiguration</command:noun> <maml:description> <maml:para>Updates paramters of the system configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates paramters of the system configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateSystemConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SystemUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SystemUpdateSpec</command:parameterValue> <dev:type> <maml:name>SystemUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SystemUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SystemUpdateSpec</command:parameterValue> <dev:type> <maml:name>SystemUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SystemUpdateSpec = Initialize-VcfSystemUpdateSpec -MaxAllowedDomainsInSubscription 0 Invoke-VcfUpdateSystemConfiguration -systemUpdateSpec $systemUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateSystemConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SystemUpdateSpec = Initialize-VcfSystemUpdateSpec -MaxAllowedDomainsInSubscription 0 Invoke-VcfUpdateSystemConfiguration -systemUpdateSpec $systemUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateSystemConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfSystemUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfConfigureDns</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfConfigureDns</command:noun> <maml:description> <maml:para>Update the DNS configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfConfigureDns</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DnsConfiguration</command:parameterValue> <dev:type> <maml:name>DnsConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DnsConfiguration</command:parameterValue> <dev:type> <maml:name>DnsConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DnsServer = Initialize-VcfDnsServer -IpAddress "10.0.0.250" -IsPrimary $false $DnsConfiguration = Initialize-VcfDnsConfiguration -DnsServers $DnsServer Invoke-VcfConfigureDns -dnsConfiguration $dnsConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConfigureDns with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DnsServer = Initialize-VcfDnsServer -IpAddress "10.0.0.250" -IsPrimary $false $DnsConfiguration = Initialize-VcfDnsConfiguration -DnsServers $DnsServer Invoke-VcfConfigureDns -dnsConfiguration $dnsConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConfigureDns with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/dns-configuration/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDnsConfiguration</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfConfigureNtp</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfConfigureNtp</command:noun> <maml:description> <maml:para>Update the NTP configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfConfigureNtp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NtpConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NtpConfiguration</command:parameterValue> <dev:type> <maml:name>NtpConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NtpConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NtpConfiguration</command:parameterValue> <dev:type> <maml:name>NtpConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NtpServer = Initialize-VcfNtpServer -IpAddress "10.0.0.250" $NtpConfiguration = Initialize-VcfNtpConfiguration -NtpServers $NtpServer Invoke-VcfConfigureNtp -ntpConfiguration $ntpConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConfigureNtp with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NtpServer = Initialize-VcfNtpServer -IpAddress "10.0.0.250" $NtpConfiguration = Initialize-VcfNtpConfiguration -NtpServers $NtpServer Invoke-VcfConfigureNtp -ntpConfiguration $ntpConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfConfigureNtp with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/ntp-configuration/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNtpConfiguration</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDnsConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDnsConfiguration</command:noun> <maml:description> <maml:para>Retrieve the DNS configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDnsConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DnsConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDnsConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDnsConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDnsConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDnsConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/dns-configuration/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNtpConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNtpConfiguration</command:noun> <maml:description> <maml:para>Retrieve the NTP configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNtpConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NtpConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNtpConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNtpConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNtpConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNtpConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/ntp-configuration/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetValidationOfDnsConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetValidationOfDnsConfiguration</command:noun> <maml:description> <maml:para>Retrieve the results of a DNS configuration validation by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetValidationOfDnsConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationOfDnsConfiguration -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationOfDnsConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationOfDnsConfiguration -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationOfDnsConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/dns-configuration/validations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetValidationOfNtpConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetValidationOfNtpConfiguration</command:noun> <maml:description> <maml:para>Retrieve the results of a NTP configuration validation by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetValidationOfNtpConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationOfNtpConfiguration -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationOfNtpConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationOfNtpConfiguration -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationOfNtpConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/ntp-configuration/validations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetValidationsOfDNSConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetValidationsOfDNSConfiguration</command:noun> <maml:description> <maml:para>Retrieve a list of DNS configuation validations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetValidationsOfDNSConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExecutionStatus</maml:name> <maml:Description> <maml:para>executionStatus</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExecutionStatus</maml:name> <maml:Description> <maml:para>executionStatus</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationsOfDNSConfiguration -executionStatus "MyexecutionStatus" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationsOfDNSConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationsOfDNSConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationsOfDNSConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/dns-configuration/validations/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetValidationsOfNtpConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetValidationsOfNtpConfiguration</command:noun> <maml:description> <maml:para>Retrieve a list of NTP configuation validations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetValidationsOfNtpConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExecutionStatus</maml:name> <maml:Description> <maml:para>executionStatus</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExecutionStatus</maml:name> <maml:Description> <maml:para>executionStatus</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationsOfNtpConfiguration -executionStatus "MyexecutionStatus" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationsOfNtpConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetValidationsOfNtpConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetValidationsOfNtpConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/ntp-configuration/validations/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateDnsConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateDnsConfiguration</command:noun> <maml:description> <maml:para>Perform validation of the DnsConfiguration specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateDnsConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DnsConfiguration</command:parameterValue> <dev:type> <maml:name>DnsConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DnsConfiguration</command:parameterValue> <dev:type> <maml:name>DnsConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DnsServer = Initialize-VcfDnsServer -IpAddress "10.0.0.250" -IsPrimary $false $DnsConfiguration = Initialize-VcfDnsConfiguration -DnsServers $DnsServer Invoke-VcfValidateDnsConfiguration -dnsConfiguration $dnsConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateDnsConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DnsServer = Initialize-VcfDnsServer -IpAddress "10.0.0.250" -IsPrimary $false $DnsConfiguration = Initialize-VcfDnsConfiguration -DnsServers $DnsServer Invoke-VcfValidateDnsConfiguration -dnsConfiguration $dnsConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateDnsConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/dns-configuration/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDnsConfiguration</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateNtpConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateNtpConfiguration</command:noun> <maml:description> <maml:para>Perform validation of the NtpConfiguration specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateNtpConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NtpConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NtpConfiguration</command:parameterValue> <dev:type> <maml:name>NtpConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NtpConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NtpConfiguration</command:parameterValue> <dev:type> <maml:name>NtpConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NtpServer = Initialize-VcfNtpServer -IpAddress "10.0.0.250" $NtpConfiguration = Initialize-VcfNtpConfiguration -NtpServers $NtpServer Invoke-VcfValidateNtpConfiguration -ntpConfiguration $ntpConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateNtpConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NtpServer = Initialize-VcfNtpServer -IpAddress "10.0.0.250" $NtpConfiguration = Initialize-VcfNtpConfiguration -NtpServers $NtpServer Invoke-VcfValidateNtpConfiguration -ntpConfiguration $ntpConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateNtpConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/ntp-configuration/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNtpConfiguration</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetPrecheckTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetPrecheckTask</command:noun> <maml:description> <maml:para>Retrieve a precheck task by its id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Monitor the progress of precheck task by the precheck task ID. As this API is deprecated, please use the new LCM Prechecks API - /v1/system/check-sets/{taskId}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetPrecheckTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Precheck Task ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Precheck Task ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetPrecheckTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPrecheckTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetPrecheckTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetPrecheckTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/prechecks/tasks/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartPrecheck</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartPrecheck</command:noun> <maml:description> <maml:para>Start a system precheck</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Perform precheck of resource(ex: Domain, Cluster). If only resource is specified, all resources/software components under it are included. If resource(Domain, Cluster etc) and specific resources/software components are provided, only those are included in precheck. As this API is deprecated, please use the new LCM Prechecks API - /v1/system/check-sets/queries and /v1/system/check-sets</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartPrecheck</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrecheckSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PrecheckSpec</command:parameterValue> <dev:type> <maml:name>PrecheckSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrecheckSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PrecheckSpec</command:parameterValue> <dev:type> <maml:name>PrecheckSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Fqdn "sfo-vc01.rainpole.io" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" -Name "MyName" -Sans "sfo-vc01.rainpole.io" $PrecheckSpec = Initialize-VcfPrecheckSpec -Resources $Resource -BundleId "MyBundleId" -Mode "MyMode" Invoke-VcfStartPrecheck -precheckSpec $precheckSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartPrecheck with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Resource = Initialize-VcfResource -ResourceId "BE8A5E04-92A0-43F6-A166-AA041F4327CC" -Type "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI" $PrecheckSpec = Initialize-VcfPrecheckSpec -Resources $Resource Invoke-VcfStartPrecheck -precheckSpec $precheckSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartPrecheck with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/prechecks/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfPrecheckSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfSystemUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>SystemUpdateSpec</command:noun> <maml:description> <maml:para>Contains the parameters required to perform update operation on system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains the parameters required to perform update operation on system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfSystemUpdateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaxAllowedDomainsInSubscription</maml:name> <maml:Description> <maml:para>new limit of amount of domains in subscription mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaxAllowedDomainsInSubscription</maml:name> <maml:Description> <maml:para>new limit of amount of domains in subscription mode</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SystemUpdateSpec = Initialize-VcfSystemUpdateSpec -MaxAllowedDomainsInSubscription 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSystemUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SystemUpdateSpec = Initialize-VcfSystemUpdateSpec -MaxAllowedDomainsInSubscription 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfSystemUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/SystemUpdateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfTagsSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>TagsSpec</command:noun> <maml:description> <maml:para>Tags Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Tags Spec</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfTagsSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagIds</maml:name> <maml:Description> <maml:para>Tag IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagIds</maml:name> <maml:Description> <maml:para>Tag IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTagsSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TagsSpec = Initialize-VcfTagsSpec -TagIds "MyTagIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTagsSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/TagsSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfTargetProductVersion</command:name> <command:verb>Initialize</command:verb> <command:noun>TargetProductVersion</command:noun> <maml:description> <maml:para>Model for target product versions in domain release view.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model for target product versions in domain release view.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfTargetProductVersion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>Product Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Target upgrade version of the product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProductType</maml:name> <maml:Description> <maml:para>Product Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Target upgrade version of the product</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TargetProductVersion = Initialize-VcfTargetProductVersion -ProductType "One among: SDDC_MANAGER, ESX, VCENTER, VXRAIL, NSX" -_Version "My_Version" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTargetProductVersion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TargetProductVersion = Initialize-VcfTargetProductVersion -ProductType "One among: SDDC_MANAGER, ESX, VCENTER, VXRAIL, NSX" -_Version "My_Version" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTargetProductVersion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/TargetProductVersion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteReleaseByDomainID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteReleaseByDomainID</command:noun> <maml:description> <maml:para>Delete the target release by its domain ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete last selected upgrade version for the domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteReleaseByDomainID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteReleaseByDomainID -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteReleaseByDomainID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteReleaseByDomainID -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteReleaseByDomainID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/domains/domainid/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetDomainReleaseViewValidation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetDomainReleaseViewValidation</command:noun> <maml:description> <maml:para>Retrieve a domain target state validation by its validation id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Monitor the progress of domain target state validation task by the validation id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetDomainReleaseViewValidation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ValidationId</maml:name> <maml:Description> <maml:para>Domain Target State Validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ValidationId</maml:name> <maml:Description> <maml:para>Domain Target State Validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainReleaseViewValidation -validationId "MyvalidationId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainReleaseViewValidation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetDomainReleaseViewValidation -validationId "MyvalidationId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetDomainReleaseViewValidation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/domains/validations/validationid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetReleaseByDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetReleaseByDomain</command:noun> <maml:description> <maml:para>Retrieve a release view for a domain by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get last selected upgrade version for the domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetReleaseByDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID to get target version of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID to get target version of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DomainReleaseView</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetReleaseByDomain -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetReleaseByDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetReleaseByDomain -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetReleaseByDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/domains/domainid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetReleaseByDomains</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetReleaseByDomains</command:noun> <maml:description> <maml:para>Retrieve a release view for all domains</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get last selected upgrade version for WLDs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetReleaseByDomains</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfDomainReleaseView</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetReleaseByDomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetReleaseByDomains with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetReleaseByDomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetReleaseByDomains with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/domains/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateReleaseByDomainID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateReleaseByDomainID</command:noun> <maml:description> <maml:para>Modify the target upgrade release for a domain by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update last selected upgrade version for the domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateReleaseByDomainID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainRelease</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainRelease</command:parameterValue> <dev:type> <maml:name>DomainRelease</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainRelease</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainRelease</command:parameterValue> <dev:type> <maml:name>DomainRelease</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TargetProductVersion = Initialize-VcfTargetProductVersion -ProductType "One among: SDDC_MANAGER, ESX, VCENTER, VXRAIL, NSX" -_Version "My_Version" $DomainRelease = Initialize-VcfDomainRelease -TargetVersion "MyTargetVersion" -TargetVxRailVersion "MyTargetVxRailVersion" -TargetSddcManagerVersion "MyTargetSddcManagerVersion" -Patches $TargetProductVersion Invoke-VcfUpdateReleaseByDomainID -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd -domainRelease $domainRelease </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateReleaseByDomainID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfUpdateReleaseByDomainID -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateReleaseByDomainID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/domains/domainid/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDomainRelease</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateReleaseByDomainID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateReleaseByDomainID</command:noun> <maml:description> <maml:para>Validate the target selected upgrade version for the domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Validate the target selected upgrade release BOM or custom BOM for a domain by its ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateReleaseByDomainID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID of the domain under validation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainRelease</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainRelease</command:parameterValue> <dev:type> <maml:name>DomainRelease</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID of the domain under validation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainRelease</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DomainRelease</command:parameterValue> <dev:type> <maml:name>DomainRelease</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TargetProductVersion = Initialize-VcfTargetProductVersion -ProductType "One among: SDDC_MANAGER, ESX, VCENTER, VXRAIL, NSX" -_Version "My_Version" $DomainRelease = Initialize-VcfDomainRelease -TargetVersion "MyTargetVersion" -TargetVxRailVersion "MyTargetVxRailVersion" -TargetSddcManagerVersion "MyTargetSddcManagerVersion" -Patches $TargetProductVersion Invoke-VcfValidateReleaseByDomainID -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd -domainRelease $domainRelease </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateReleaseByDomainID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DomainRelease = Initialize-VcfDomainRelease Invoke-VcfValidateReleaseByDomainID -domainId 9ab78840-ee25-11e8-a8fc-d71c338107bd -domainRelease $domainRelease </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateReleaseByDomainID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/releases/domains/domainid/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfDomainRelease</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCancelTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCancelTask</command:noun> <maml:description> <maml:para>Cancel a Task</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Cancel a Task by ID, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCancelTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task id for cancelling</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task id for cancelling</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfCancelTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCancelTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfCancelTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCancelTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/tasks/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTask</command:noun> <maml:description> <maml:para>Retrieve a task by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Task by ID, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task id to retrieve</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task id to retrieve</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/tasks/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTasks</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTasks</command:noun> <maml:description> <maml:para>Retrieve a list of all tasks</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the tasks</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTasks</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>The number of elements to be returned in the result</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskStatus</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompletedAfter</maml:name> <maml:Description> <maml:para>A time based filter to get tasks which are completed after the given timestamp. A task is completed if its status is 'Successful' or 'Failed'. Time is in milliseconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageNumber</maml:name> <maml:Description> <maml:para>Page number.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Size of the page you want to retrieve. Max page size allowed is 100.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrderDirection</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskName</maml:name> <maml:Description> <maml:para>Search filter when task name contains text.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>The number of elements to be returned in the result</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskStatus</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompletedAfter</maml:name> <maml:Description> <maml:para>A time based filter to get tasks which are completed after the given timestamp. A task is completed if its status is 'Successful' or 'Failed'. Time is in milliseconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageNumber</maml:name> <maml:Description> <maml:para>Page number.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Size of the page you want to retrieve. Max page size allowed is 100.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrderDirection</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskName</maml:name> <maml:Description> <maml:para>Search filter when task name contains text.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTasks -limit 56 -taskStatus "MytaskStatus" -taskType "MytaskType" -resourceId "MyresourceId" -resourceType "MyresourceType" -completedAfter 789 -pageNumber 56 -pageSize 56 -orderDirection "MyorderDirection" -orderBy "MyorderBy" -taskName "MytaskName" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTasks with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTasks </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTasks with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/tasks/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRetryTask</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRetryTask</command:noun> <maml:description> <maml:para>Retry a Task</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retry a failed Task by ID, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRetryTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task id retry</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Task id retry</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRetryTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRetryTask with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRetryTask -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRetryTask with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/tasks/id/patch/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfTeamingSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>TeamingSpec</command:noun> <maml:description> <maml:para>This specification contains the teaming policies associated with the uplink profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the teaming policies associated with the uplink profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfTeamingSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Policy</maml:name> <maml:Description> <maml:para>The teaming policy associated with the uplink profile</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActiveUplinks</maml:name> <maml:Description> <maml:para>The list of active uplinks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandByUplinks</maml:name> <maml:Description> <maml:para>The list of stand by uplinks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Policy</maml:name> <maml:Description> <maml:para>The teaming policy associated with the uplink profile</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActiveUplinks</maml:name> <maml:Description> <maml:para>The list of active uplinks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StandByUplinks</maml:name> <maml:Description> <maml:para>The list of stand by uplinks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTeamingSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTeamingSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/TeamingSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfTemporaryNetwork</command:name> <command:verb>Initialize</command:verb> <command:noun>TemporaryNetwork</command:noun> <maml:description> <maml:para>Temporary Network for vCenter Upgrade</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Temporary Network for vCenter Upgrade</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfTemporaryNetwork</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP Address for vCenter Upgrade temporary network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubnetMask</maml:name> <maml:Description> <maml:para>Subnet Mask for vCenter Upgrade temporary network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>Gateway for vCenter Upgrade temporary network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP Address for vCenter Upgrade temporary network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SubnetMask</maml:name> <maml:Description> <maml:para>Subnet Mask for vCenter Upgrade temporary network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>Gateway for vCenter Upgrade temporary network</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TemporaryNetwork = Initialize-VcfTemporaryNetwork -IpAddress "MyIpAddress" -SubnetMask "MySubnetMask" -Gateway "MyGateway" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTemporaryNetwork with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TemporaryNetwork = Initialize-VcfTemporaryNetwork -IpAddress "MyIpAddress" -SubnetMask "MySubnetMask" -Gateway "MyGateway" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTemporaryNetwork with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/TemporaryNetwork</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfTokenCreationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>TokenCreationSpec</command:noun> <maml:description> <maml:para>The spec used to sign the token</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The spec used to sign the token</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfTokenCreationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>User Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApiKey</maml:name> <maml:Description> <maml:para>API Key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdToken</maml:name> <maml:Description> <maml:para>Id Token</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>User Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApiKey</maml:name> <maml:Description> <maml:para>API Key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdToken</maml:name> <maml:Description> <maml:para>Id Token</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TokenCreationSpec = Initialize-VcfTokenCreationSpec -Username "MyUsername" -Password "MyPassword" -ApiKey "MyApiKey" -IdToken "MyIdToken" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTokenCreationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TokenCreationSpec = Initialize-VcfTokenCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTokenCreationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/TokenCreationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfCreateToken</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfCreateToken</command:noun> <maml:description> <maml:para>Create Token Pair</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates access token and refresh token for user access</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfCreateToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TokenCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TokenCreationSpec</command:parameterValue> <dev:type> <maml:name>TokenCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TokenCreationSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TokenCreationSpec</command:parameterValue> <dev:type> <maml:name>TokenCreationSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>TokenPair</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TokenCreationSpec = Initialize-VcfTokenCreationSpec -Username "MyUsername" -Password "MyPassword" -ApiKey "MyApiKey" -IdToken "MyIdToken" Invoke-VcfCreateToken -tokenCreationSpec $tokenCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateToken with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TokenCreationSpec = Initialize-VcfTokenCreationSpec Invoke-VcfCreateToken -tokenCreationSpec $tokenCreationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfCreateToken with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/tokens/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfTokenCreationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfInvalidateRefreshToken</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfInvalidateRefreshToken</command:noun> <maml:description> <maml:para>Invalidate Refresh Token</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Invalidate the provided refresh token</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfInvalidateRefreshToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfInvalidateRefreshToken -body "Mybody" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfInvalidateRefreshToken with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfInvalidateRefreshToken -body "Mybody" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfInvalidateRefreshToken with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/tokens/refresh-token/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRefreshAccessToken</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRefreshAccessToken</command:noun> <maml:description> <maml:para>Refresh Access Token</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Refresh the access token associated with the given refresh token</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRefreshAccessToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>string</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRefreshAccessToken -body "Mybody" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRefreshAccessToken with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRefreshAccessToken -body "Mybody" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRefreshAccessToken with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/tokens/access-token/refresh/patch/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfTransportZone</command:name> <command:verb>Initialize</command:verb> <command:noun>TransportZone</command:noun> <maml:description> <maml:para>The transport zone to be associated with the vSphere Distributed Switch managed by NSX</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The transport zone to be associated with the vSphere Distributed Switch managed by NSX</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfTransportZone</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the transport zone</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransportType</maml:name> <maml:Description> <maml:para>The type of the transport zone</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the transport zone</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransportType</maml:name> <maml:Description> <maml:para>The type of the transport zone</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTransportZone with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TransportZone = Initialize-VcfTransportZone -TransportType "One among: VLAN, OVERLAY" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTransportZone with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/TransportZone</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddTrustedCertificate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddTrustedCertificate</command:noun> <maml:description> <maml:para>Add a trusted certificate to the SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add a trusted certificate to the SDDC Manager</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddTrustedCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TrustedCertificateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCertificateSpec</command:parameterValue> <dev:type> <maml:name>TrustedCertificateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TrustedCertificateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrustedCertificateSpec</command:parameterValue> <dev:type> <maml:name>TrustedCertificateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Page</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TrustedCertificateSpec = Initialize-VcfTrustedCertificateSpec -Certificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" -CertificateUsageType "One among: TRUSTED_FOR_OUTBOUND, TRUSTED_FOR_INBOUND" Invoke-VcfAddTrustedCertificate -trustedCertificateSpec $trustedCertificateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddTrustedCertificate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TrustedCertificateSpec = Initialize-VcfTrustedCertificateSpec -Certificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" Invoke-VcfAddTrustedCertificate -trustedCertificateSpec $trustedCertificateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddTrustedCertificate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sddc-manager/trusted-certificates/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfTrustedCertificateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteTrustedCertificate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteTrustedCertificate</command:noun> <maml:description> <maml:para>Delete a trusted certificate from the SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a trusted certificate from the SDDC Manager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteTrustedCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Alias</maml:name> <maml:Description> <maml:para>Certificate Alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Alias</maml:name> <maml:Description> <maml:para>Certificate Alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteTrustedCertificate -alias "Myalias" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteTrustedCertificate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteTrustedCertificate -alias "Myalias" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteTrustedCertificate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sddc-manager/trusted-certificates/alias/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetTrustedCertificates</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetTrustedCertificates</command:noun> <maml:description> <maml:para>Retrieve all trusted certificates from SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve all trusted certificates from SDDC Manager</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetTrustedCertificates</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfTrustedCertificate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetTrustedCertificates </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTrustedCertificates with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetTrustedCertificates </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetTrustedCertificates with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sddc-manager/trusted-certificates/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfTrustedCertificateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>TrustedCertificateSpec</command:noun> <maml:description> <maml:para>This specification contains certificate & certificate usage</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains certificate & certificate usage</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfTrustedCertificateSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Certificate in PEM format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateUsageType</maml:name> <maml:Description> <maml:para>Certificate usage</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificate</maml:name> <maml:Description> <maml:para>Certificate in PEM format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateUsageType</maml:name> <maml:Description> <maml:para>Certificate usage</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TrustedCertificateSpec = Initialize-VcfTrustedCertificateSpec -Certificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" -CertificateUsageType "One among: TRUSTED_FOR_OUTBOUND, TRUSTED_FOR_INBOUND" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTrustedCertificateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TrustedCertificateSpec = Initialize-VcfTrustedCertificateSpec -Certificate "-----BEGIN CERTIFICATE----- MIIFq... -----END CERTIFICATE-----" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfTrustedCertificateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/TrustedCertificateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfUnmanagedResourceCredential</command:name> <command:verb>Initialize</command:verb> <command:noun>UnmanagedResourceCredential</command:noun> <maml:description> <maml:para>Represents credentials of am unmanaged resource (i.e a resource that is not managed by VCF)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents credentials of am unmanaged resource (i.e a resource that is not managed by VCF)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfUnmanagedResourceCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialType</maml:name> <maml:Description> <maml:para>Credential type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialType</maml:name> <maml:Description> <maml:para>Credential type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>Username</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUnmanagedResourceCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUnmanagedResourceCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/UnmanagedResourceCredential</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetNsxUpgradeResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetNsxUpgradeResources</command:noun> <maml:description> <maml:para>Retrieve a list of all upgradable NSX resources for a domain by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the list NSX upgradable reosurce with resource metadata info</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetNsxUpgradeResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>bundle Id of the upgrade bundle applicable on the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>bundle Id of the upgrade bundle applicable on the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>NsxtResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxUpgradeResources -domainId "MydomainId" -bundleId "MybundleId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxUpgradeResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetNsxUpgradeResources -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetNsxUpgradeResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/upgradables/domains/domainid/nsxt/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetUpgradables</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetUpgradables</command:noun> <maml:description> <maml:para>Retrieve a list of all upgradable resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Fetches the list of Upgradables in the System. Only one Upgradable becomes AVAILABLE for Upgrade. The Upgradables provides information that can be use for Precheck API and also in the actual Upgrade API call.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetUpgradables</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfUpgradable</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradables </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradables with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradables </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradables with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/upgradables/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetUpgradablesByDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetUpgradablesByDomain</command:noun> <maml:description> <maml:para>Retrieve a list of all upgradable resources for a domain by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Fetches the list of Upgradables for a given domain. If a target version is provided, Upgradables that are required for given target version become Available. The Upgradables providesinformation that can be use for Precheck API and also in the actual Upgrade API call.This API is used only for management domain, for all cases please use v1/system/upgradables.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetUpgradablesByDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVersion</maml:name> <maml:Description> <maml:para>Target Version to get Upgradables for a given Target Release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVersion</maml:name> <maml:Description> <maml:para>Target Version to get Upgradables for a given Target Release</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfUpgradable</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradablesByDomain -domainId "MydomainId" -targetVersion 4.0.1.0 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradablesByDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradablesByDomain -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradablesByDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/upgradables/domains/domainid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetUpgradablesClusters</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetUpgradablesClusters</command:noun> <maml:description> <maml:para>Retrieve a list of upgradable packages details from HSM for a domain by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Fetches the list of available hardware support managers and configured hardware support managers for the give resource along with the hardware support packages and Software details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetUpgradablesClusters</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfUpgradablesClusterResource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradablesClusters -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradablesClusters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradablesClusters -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradablesClusters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/upgradables/domains/domainid/clusters/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfUpgradeCommitSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>UpgradeCommitSpec</command:noun> <maml:description> <maml:para>Upgrade Commit/Reschedule Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upgrade Commit/Reschedule Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfUpgradeCommitSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ScheduledTimestamp</maml:name> <maml:Description> <maml:para>Upgrade Scheduled Time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeNow</maml:name> <maml:Description> <maml:para>Flag for enabling Upgrade Now. If true, scheduledTimestamp is ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MarkForCancellation</maml:name> <maml:Description> <maml:para>Flag for marking an upgrade for cancellation. If set to true, other fields in the request will be ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ScheduledTimestamp</maml:name> <maml:Description> <maml:para>Upgrade Scheduled Time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeNow</maml:name> <maml:Description> <maml:para>Flag for enabling Upgrade Now. If true, scheduledTimestamp is ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MarkForCancellation</maml:name> <maml:Description> <maml:para>Flag for marking an upgrade for cancellation. If set to true, other fields in the request will be ignored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UpgradeCommitSpec = Initialize-VcfUpgradeCommitSpec -ScheduledTimestamp "MyScheduledTimestamp" -UpgradeNow $false -MarkForCancellation $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUpgradeCommitSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UpgradeCommitSpec = Initialize-VcfUpgradeCommitSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUpgradeCommitSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/UpgradeCommitSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetUpgradeById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetUpgradeById</command:noun> <maml:description> <maml:para>Retrieve an upgrade by ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve an upgrade by ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetUpgradeById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Upgrade</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradeById -upgradeId "MyupgradeId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradeById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradeById -upgradeId "MyupgradeId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradeById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/upgrades/upgradeid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetUpgradePrecheckByID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetUpgradePrecheckByID</command:noun> <maml:description> <maml:para>Retrieve an upgrade precheck task by ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets upgrade precheck details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetUpgradePrecheckByID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrecheckId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrecheckId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradePrecheckByID -upgradeId "MyupgradeId" -precheckId "MyprecheckId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradePrecheckByID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgradePrecheckByID -upgradeId "MyupgradeId" -precheckId "MyprecheckId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgradePrecheckByID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/upgrades/upgradeid/prechecks/precheckid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetUpgrades</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetUpgrades</command:noun> <maml:description> <maml:para>Retrieve a list of upgrades</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a list of upgrades</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetUpgrades</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Status of the upgrades you want to retrieve</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>Bundle Id for the upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleType</maml:name> <maml:Description> <maml:para>Bundle type of the upgrades you want to retrieve</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Status of the upgrades you want to retrieve</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>Bundle Id for the upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleType</maml:name> <maml:Description> <maml:para>Bundle type of the upgrades you want to retrieve</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfUpgrade</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgrades -status "Mystatus" -bundleId "MybundleId" -bundleType "MybundleType" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgrades with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetUpgrades </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUpgrades with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/upgrades/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfPerformUpgrade</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfPerformUpgrade</command:noun> <maml:description> <maml:para>Start an upgrade operation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Schedule/Trigger Upgrade of a Resource. Ex: Resource can be DOMAIN, CLUSTER, UNMANAGED_HOST etc. Performing upgrades are supported on VMware Cloud Foundation 3.5 BOM resources and above. Supports scheduling/triggering of only 'parallel' upgrades and only Resource 'cluster' that are managed using both vSphere Lifecycle Manager Baselines and vSphere Lifecycle Manager Images in the same request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfPerformUpgrade</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UpgradeSpec</command:parameterValue> <dev:type> <maml:name>UpgradeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UpgradeSpec</command:parameterValue> <dev:type> <maml:name>UpgradeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PackageSpec = Initialize-VcfPackageSpec -Name "MyName" -_Version "My_Version" $HardwareSupportSpec = Initialize-VcfHardwareSupportSpec -Name "MyName" -PackageSpec $PackageSpec $PersonalitySpec = Initialize-VcfPersonalitySpec -PersonalityId "MyPersonalityId" -HardwareSupportSpecs $HardwareSupportSpec $CustomISOSpec = Initialize-VcfCustomISOSpec -Id "MyId" $EsxUpgradeFailureAction = Initialize-VcfEsxUpgradeFailureAction -RetryDelay 0 -RetryCount 0 -Action "FAIL, RETRY" $EsxUpgradeOptionsSpec = Initialize-VcfEsxUpgradeOptionsSpec -EsxUpgradeFailureAction $EsxUpgradeFailureAction -EnforceHclValidation $false -EnableQuickPatch $false -EnableQuickboot $false -EvacuateOfflineVms $false -DisableHac $false -DisableDpm $false -PreRemediationPowerAction "POWER_OFF_VMS, SUSPEND_VMS, DO_NOT_CHANGE_VMS_POWER_STATE, SUSPEND_VMS_TO_MEMORY" $ResourceUpgradeSpec = Initialize-VcfResourceUpgradeSpec -ResourceId "MyResourceId" -ShutdownVms $false -ToVersion "MyToVersion" -ScheduledTimestamp "MyScheduledTimestamp" -UpgradeNow $false -PersonalitySpec $PersonalitySpec -CustomIsoSpec $CustomISOSpec -EnableQuickboot $false -EvacuateOfflineVms $false -EsxUpgradeOptionsSpec $EsxUpgradeOptionsSpec $NsxtHostClusterUpgradeSpec = Initialize-VcfNsxtHostClusterUpgradeSpec -HostClusterId "MyHostClusterId" -HostParallelUpgrade $false -LiveUpgrade $false $NsxtEdgeClusterUpgradeSpec = Initialize-VcfNsxtEdgeClusterUpgradeSpec -EdgeClusterId "MyEdgeClusterId" -EdgeParallelUpgrade $false $NsxtUpgradeOptions = Initialize-VcfNsxtUpgradeOptions -IsEdgeOnlyUpgrade $false -IsHostClustersUpgradeParallel $false -IsEdgeClustersUpgradeParallel $false $NsxtUpgradeUserInputSpec = Initialize-VcfNsxtUpgradeUserInputSpec -NsxtHostClusterUpgradeSpecs $NsxtHostClusterUpgradeSpec -NsxtEdgeClusterUpgradeSpecs $NsxtEdgeClusterUpgradeSpec -NsxtUpgradeOptions $NsxtUpgradeOptions -NsxtId "MyNsxtId" $TemporaryNetwork = Initialize-VcfTemporaryNetwork -IpAddress "MyIpAddress" -SubnetMask "MySubnetMask" -Gateway "MyGateway" $VcenterUpgradeUserInputSpec = Initialize-VcfVcenterUpgradeUserInputSpec -TemporaryNetwork $TemporaryNetwork $UpgradeSpec = Initialize-VcfUpgradeSpec -BundleId "MyBundleId" -ResourceType "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST" -ParallelUpgrade $false -DraftMode $false -ResourceUpgradeSpecs $ResourceUpgradeSpec -NsxtUpgradeUserInputSpecs $NsxtUpgradeUserInputSpec -VcenterUpgradeUserInputSpecs $VcenterUpgradeUserInputSpec Invoke-VcfPerformUpgrade -upgradeSpec $upgradeSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPerformUpgrade with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceUpgradeSpec = Initialize-VcfResourceUpgradeSpec -ResourceId "MyResourceId" $UpgradeSpec = Initialize-VcfUpgradeSpec -BundleId "MyBundleId" -ResourceType "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST" -ResourceUpgradeSpecs $ResourceUpgradeSpec Invoke-VcfPerformUpgrade -upgradeSpec $upgradeSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfPerformUpgrade with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/upgrades/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfUpgradeSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfStartUpgradePrecheck</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfStartUpgradePrecheck</command:noun> <maml:description> <maml:para>Start an upgrade precheck operation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Perform Upgrade Prechecks</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfStartUpgradePrecheck</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Task</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfStartUpgradePrecheck -upgradeId "MyupgradeId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartUpgradePrecheck with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfStartUpgradePrecheck -upgradeId "MyupgradeId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfStartUpgradePrecheck with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/upgrades/upgradeid/prechecks/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateUpgradeSchedule</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateUpgradeSchedule</command:noun> <maml:description> <maml:para>Change a DRAFT upgrade to a SCHEDULED state</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Commit/Reschedule an existing upgrade. It moves the upgrade from DRAFT state to SCHEDULED state and/or changes the upgrade scheduled date/time.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateUpgradeSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeCommitSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UpgradeCommitSpec</command:parameterValue> <dev:type> <maml:name>UpgradeCommitSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpgradeCommitSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UpgradeCommitSpec</command:parameterValue> <dev:type> <maml:name>UpgradeCommitSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Upgrade</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UpgradeCommitSpec = Initialize-VcfUpgradeCommitSpec -ScheduledTimestamp "MyScheduledTimestamp" -UpgradeNow $false -MarkForCancellation $false Invoke-VcfUpdateUpgradeSchedule -upgradeId "MyupgradeId" -upgradeCommitSpec $upgradeCommitSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateUpgradeSchedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UpgradeCommitSpec = Initialize-VcfUpgradeCommitSpec Invoke-VcfUpdateUpgradeSchedule -upgradeId "MyupgradeId" -upgradeCommitSpec $upgradeCommitSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateUpgradeSchedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/upgrades/upgradeid/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfUpgradeCommitSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfUpgradeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>UpgradeSpec</command:noun> <maml:description> <maml:para>Upgrade Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upgrade Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfUpgradeSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>Bundle ID for Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource Type for Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParallelUpgrade</maml:name> <maml:Description> <maml:para>Boolean to represent components will be upgraded in parallel on not</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DraftMode</maml:name> <maml:Description> <maml:para>Boolean to represent upgrade will be created in DRAFT mode. This allows to run prechecks before user confirm/commit the upgrade.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceUpgradeSpecs</maml:name> <maml:Description> <maml:para>Resource Upgrade Specifications</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceUpgradeSpec></command:parameterValue> <dev:type> <maml:name>List<ResourceUpgradeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtUpgradeUserInputSpecs</maml:name> <maml:Description> <maml:para>Resource Upgrade Specifications for NSX upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtUpgradeUserInputSpec></command:parameterValue> <dev:type> <maml:name>List<NsxtUpgradeUserInputSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterUpgradeUserInputSpecs</maml:name> <maml:Description> <maml:para>User Input for vCenter upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VcenterUpgradeUserInputSpec></command:parameterValue> <dev:type> <maml:name>List<VcenterUpgradeUserInputSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleId</maml:name> <maml:Description> <maml:para>Bundle ID for Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceType</maml:name> <maml:Description> <maml:para>Resource Type for Upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParallelUpgrade</maml:name> <maml:Description> <maml:para>Boolean to represent components will be upgraded in parallel on not</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DraftMode</maml:name> <maml:Description> <maml:para>Boolean to represent upgrade will be created in DRAFT mode. This allows to run prechecks before user confirm/commit the upgrade.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceUpgradeSpecs</maml:name> <maml:Description> <maml:para>Resource Upgrade Specifications</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceUpgradeSpec></command:parameterValue> <dev:type> <maml:name>List<ResourceUpgradeSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtUpgradeUserInputSpecs</maml:name> <maml:Description> <maml:para>Resource Upgrade Specifications for NSX upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NsxtUpgradeUserInputSpec></command:parameterValue> <dev:type> <maml:name>List<NsxtUpgradeUserInputSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterUpgradeUserInputSpecs</maml:name> <maml:Description> <maml:para>User Input for vCenter upgrade</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VcenterUpgradeUserInputSpec></command:parameterValue> <dev:type> <maml:name>List<VcenterUpgradeUserInputSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PackageSpec = Initialize-VcfPackageSpec -Name "MyName" -_Version "My_Version" $HardwareSupportSpec = Initialize-VcfHardwareSupportSpec -Name "MyName" -PackageSpec $PackageSpec $PersonalitySpec = Initialize-VcfPersonalitySpec -PersonalityId "MyPersonalityId" -HardwareSupportSpecs $HardwareSupportSpec $CustomISOSpec = Initialize-VcfCustomISOSpec -Id "MyId" $EsxUpgradeFailureAction = Initialize-VcfEsxUpgradeFailureAction -RetryDelay 0 -RetryCount 0 -Action "FAIL, RETRY" $EsxUpgradeOptionsSpec = Initialize-VcfEsxUpgradeOptionsSpec -EsxUpgradeFailureAction $EsxUpgradeFailureAction -EnforceHclValidation $false -EnableQuickPatch $false -EnableQuickboot $false -EvacuateOfflineVms $false -DisableHac $false -DisableDpm $false -PreRemediationPowerAction "POWER_OFF_VMS, SUSPEND_VMS, DO_NOT_CHANGE_VMS_POWER_STATE, SUSPEND_VMS_TO_MEMORY" $ResourceUpgradeSpec = Initialize-VcfResourceUpgradeSpec -ResourceId "MyResourceId" -ShutdownVms $false -ToVersion "MyToVersion" -ScheduledTimestamp "MyScheduledTimestamp" -UpgradeNow $false -PersonalitySpec $PersonalitySpec -CustomIsoSpec $CustomISOSpec -EnableQuickboot $false -EvacuateOfflineVms $false -EsxUpgradeOptionsSpec $EsxUpgradeOptionsSpec $NsxtHostClusterUpgradeSpec = Initialize-VcfNsxtHostClusterUpgradeSpec -HostClusterId "MyHostClusterId" -HostParallelUpgrade $false -LiveUpgrade $false $NsxtEdgeClusterUpgradeSpec = Initialize-VcfNsxtEdgeClusterUpgradeSpec -EdgeClusterId "MyEdgeClusterId" -EdgeParallelUpgrade $false $NsxtUpgradeOptions = Initialize-VcfNsxtUpgradeOptions -IsEdgeOnlyUpgrade $false -IsHostClustersUpgradeParallel $false -IsEdgeClustersUpgradeParallel $false $NsxtUpgradeUserInputSpec = Initialize-VcfNsxtUpgradeUserInputSpec -NsxtHostClusterUpgradeSpecs $NsxtHostClusterUpgradeSpec -NsxtEdgeClusterUpgradeSpecs $NsxtEdgeClusterUpgradeSpec -NsxtUpgradeOptions $NsxtUpgradeOptions -NsxtId "MyNsxtId" $TemporaryNetwork = Initialize-VcfTemporaryNetwork -IpAddress "MyIpAddress" -SubnetMask "MySubnetMask" -Gateway "MyGateway" $VcenterUpgradeUserInputSpec = Initialize-VcfVcenterUpgradeUserInputSpec -TemporaryNetwork $TemporaryNetwork $UpgradeSpec = Initialize-VcfUpgradeSpec -BundleId "MyBundleId" -ResourceType "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST" -ParallelUpgrade $false -DraftMode $false -ResourceUpgradeSpecs $ResourceUpgradeSpec -NsxtUpgradeUserInputSpecs $NsxtUpgradeUserInputSpec -VcenterUpgradeUserInputSpecs $VcenterUpgradeUserInputSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUpgradeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceUpgradeSpec = Initialize-VcfResourceUpgradeSpec -ResourceId "MyResourceId" $UpgradeSpec = Initialize-VcfUpgradeSpec -BundleId "MyBundleId" -ResourceType "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST" -ResourceUpgradeSpecs $ResourceUpgradeSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUpgradeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/UpgradeSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfUplinkMapping</command:name> <command:verb>Initialize</command:verb> <command:noun>UplinkMapping</command:noun> <maml:description> <maml:para>The map of vSphere Distributed Switch uplinks to the NSX switch uplinks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The map of vSphere Distributed Switch uplinks to the NSX switch uplinks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfUplinkMapping</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsUplinkName</maml:name> <maml:Description> <maml:para>The uplink name of the vSphere Distributed Switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxUplinkName</maml:name> <maml:Description> <maml:para>The uplink name of the NSX switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsUplinkName</maml:name> <maml:Description> <maml:para>The uplink name of the vSphere Distributed Switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxUplinkName</maml:name> <maml:Description> <maml:para>The uplink name of the NSX switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUplinkMapping with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UplinkMapping = Initialize-VcfUplinkMapping -VdsUplinkName "MyVdsUplinkName" -NsxUplinkName "MyNsxUplinkName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUplinkMapping with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/UplinkMapping</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfUplinkProfile</command:name> <command:verb>Initialize</command:verb> <command:noun>UplinkProfile</command:noun> <maml:description> <maml:para>This specification contains the policies for the links from hypervisor hosts to NSX logical switch.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the policies for the links from hypervisor hosts to NSX logical switch.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfUplinkProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The uplink profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Teamings</maml:name> <maml:Description> <maml:para>The teaming policies to be associated with the uplink profile</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<TeamingSpec></command:parameterValue> <dev:type> <maml:name>List<TeamingSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransportVlan</maml:name> <maml:Description> <maml:para>The VLAN used for tagging overlay traffic of the associated Host Switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SupportedTeamingPolicies</maml:name> <maml:Description> <maml:para>List of supported teaming policies in NSX</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The uplink profile name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Teamings</maml:name> <maml:Description> <maml:para>The teaming policies to be associated with the uplink profile</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<TeamingSpec></command:parameterValue> <dev:type> <maml:name>List<TeamingSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TransportVlan</maml:name> <maml:Description> <maml:para>The VLAN used for tagging overlay traffic of the associated Host Switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SupportedTeamingPolicies</maml:name> <maml:Description> <maml:para>List of supported teaming policies in NSX</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec -TransportVlan 0 -SupportedTeamingPolicies @{ key_example = "MyInner" } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUplinkProfile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $TeamingSpec = Initialize-VcfTeamingSpec -Policy "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC" -ActiveUplinks "MyActiveUplinks" $UplinkProfile = Initialize-VcfUplinkProfile -Name "MyName" -Teamings $TeamingSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUplinkProfile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/UplinkProfile</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfUser</command:name> <command:verb>Initialize</command:verb> <command:noun>User</command:noun> <maml:description> <maml:para>Represents user and its attributes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents user and its attributes</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>The domain of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApiKey</maml:name> <maml:Description> <maml:para>The API key of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RoleReference</command:parameterValue> <dev:type> <maml:name>RoleReference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTimestamp</maml:name> <maml:Description> <maml:para>The timestamp at which the user was created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Domain</maml:name> <maml:Description> <maml:para>The domain of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApiKey</maml:name> <maml:Description> <maml:para>The API key of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RoleReference</command:parameterValue> <dev:type> <maml:name>RoleReference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTimestamp</maml:name> <maml:Description> <maml:para>The timestamp at which the user was created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $RoleReference = Initialize-VcfRoleReference -Id "MyId" $User = Initialize-VcfUser -Id "MyId" -Name "MyName" -Domain "MyDomain" -Type "One among: USER, GROUP, SERVICE" -ApiKey "MyApiKey" -Role $RoleReference -CreationTimestamp "MyCreationTimestamp" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $RoleReference = Initialize-VcfRoleReference -Id "MyId" $User = Initialize-VcfUser -Name "MyName" -Type "One among: USER, GROUP, SERVICE" -Role $RoleReference </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/User</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfRoleReference</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddUsers</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddUsers</command:noun> <maml:description> <maml:para>Assign access to users in SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add list of users</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddUsers</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<User></command:parameterValue> <dev:type> <maml:name>List<User></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<User></command:parameterValue> <dev:type> <maml:name>List<User></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$RoleReference = Initialize-VcfRoleReference -Id "MyId" $User = Initialize-VcfUser -Id "MyId" -Name "MyName" -Domain "MyDomain" -Type "One among: USER, GROUP, SERVICE" -ApiKey "MyApiKey" -Role $RoleReference -CreationTimestamp "MyCreationTimestamp" Invoke-VcfAddUsers -user $user </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddUsers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RoleReference = Initialize-VcfRoleReference -Id "MyId" $User = Initialize-VcfUser -Name "MyName" -Type "One among: USER, GROUP, SERVICE" -Role $RoleReference Invoke-VcfAddUsers -user $user </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddUsers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/users/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDisableLocalAccount</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDisableLocalAccount</command:noun> <maml:description> <maml:para>Disable local account</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disable local account</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDisableLocalAccount</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDisableLocalAccount </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDisableLocalAccount with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDisableLocalAccount </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDisableLocalAccount with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/users/local/admin/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetLocalAccount</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetLocalAccount</command:noun> <maml:description> <maml:para>Get local account details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information on the local account</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetLocalAccount</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>LocalUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetLocalAccount </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLocalAccount with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetLocalAccount </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetLocalAccount with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/users/local/admin/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetRoles</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetRoles</command:noun> <maml:description> <maml:para>Retrieve a list of roles from SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all roles</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetRoles</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfRole</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetRoles </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetRoles with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetRoles </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetRoles with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/roles/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSSODomainEntities</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSSODomainEntities</command:noun> <maml:description> <maml:para>Retrieve a list of users and groups from a domain in vCenter Single Sign-On</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all entities in the SSO domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSSODomainEntities</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomain</maml:name> <maml:Description> <maml:para>SSO Domain Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EntityName</maml:name> <maml:Description> <maml:para>Search Criteria for the users and groups </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SsoDomain</maml:name> <maml:Description> <maml:para>SSO Domain Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EntityName</maml:name> <maml:Description> <maml:para>Search Criteria for the users and groups </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfSsoDomainEntity</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSSODomainEntities -ssoDomain "MyssoDomain" -entityName "MyentityName" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSSODomainEntities with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSSODomainEntities -ssoDomain "MyssoDomain" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSSODomainEntities with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sso-domains/sso-domain/entities/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetSSODomains</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetSSODomains</command:noun> <maml:description> <maml:para>Retrieive a list of domains from vCenter Single Sign-On</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all SSO domains</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetSSODomains</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfString</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetSSODomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSSODomains with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetSSODomains </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetSSODomains with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/sso-domains/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetUiUsers</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetUiUsers</command:noun> <maml:description> <maml:para>Retrieve a list of users assigned access via SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a list of users assigned access via SDDC Manager</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetUiUsers</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetUiUsers </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUiUsers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetUiUsers </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUiUsers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/users/ui/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetUsers</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetUsers</command:noun> <maml:description> <maml:para>Retrieve a list of users from SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all users</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetUsers</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetUsers </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUsers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetUsers </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetUsers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/users/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRemoveUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRemoveUser</command:noun> <maml:description> <maml:para>Remove access for a user in SDDC Manager</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete the user by the ID, if it exists</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRemoveUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveUser -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveUser -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/users/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateLocalUserPassword</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateLocalUserPassword</command:noun> <maml:description> <maml:para>Update password for local account</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the password for local account only if the old password is correct, or if user configures the local account for the first time</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateLocalUserPassword</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalAccountPasswordInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LocalAccountPasswordInfo</command:parameterValue> <dev:type> <maml:name>LocalAccountPasswordInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LocalAccountPasswordInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LocalAccountPasswordInfo</command:parameterValue> <dev:type> <maml:name>LocalAccountPasswordInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LocalAccountPasswordInfo = Initialize-VcfLocalAccountPasswordInfo -OldPassword "MyOldPassword" -NewPassword "MyNewPassword" Invoke-VcfUpdateLocalUserPassword -localAccountPasswordInfo $localAccountPasswordInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateLocalUserPassword with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LocalAccountPasswordInfo = Initialize-VcfLocalAccountPasswordInfo -NewPassword "MyNewPassword" Invoke-VcfUpdateLocalUserPassword -localAccountPasswordInfo $localAccountPasswordInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateLocalUserPassword with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/users/local/admin/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfLocalAccountPasswordInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVasaProvider</command:name> <command:verb>Initialize</command:verb> <command:noun>VasaProvider</command:noun> <maml:description> <maml:para>VASA Provider representation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>VASA Provider representation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVasaProvider</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>URL of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainers</maml:name> <maml:Description> <maml:para>List of storage containers associated with the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<StorageContainer></command:parameterValue> <dev:type> <maml:name>List<StorageContainer></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Users</maml:name> <maml:Description> <maml:para>List of users associated with the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VasaUser></command:parameterValue> <dev:type> <maml:name>List<VasaUser></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>URL of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainers</maml:name> <maml:Description> <maml:para>List of storage containers associated with the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<StorageContainer></command:parameterValue> <dev:type> <maml:name>List<StorageContainer></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Users</maml:name> <maml:Description> <maml:para>List of users associated with the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VasaUser></command:parameterValue> <dev:type> <maml:name>List<VasaUser></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $StorageContainer = Initialize-VcfStorageContainer -Id "MyId" -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" -ClusterId "MyClusterId" $VasaUser = Initialize-VcfVasaUser -Id "MyId" -Username "MyUsername" -Password "MyPassword" $VasaProvider = Initialize-VcfVasaProvider -Id "MyId" -Name "MyName" -Url "MyUrl" -StorageContainers $StorageContainer -Users $VasaUser </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaProvider with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $StorageContainer = Initialize-VcfStorageContainer -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" $VasaUser = Initialize-VcfVasaUser -Username "MyUsername" -Password "MyPassword" $VasaProvider = Initialize-VcfVasaProvider -Name "MyName" -Url "MyUrl" -StorageContainers $StorageContainer -Users $VasaUser </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaProvider with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VasaProvider</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddVasaProvider</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddVasaProvider</command:noun> <maml:description> <maml:para>Add a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddVasaProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProvider</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaProvider</command:parameterValue> <dev:type> <maml:name>VasaProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProvider</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaProvider</command:parameterValue> <dev:type> <maml:name>VasaProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VasaProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StorageContainer = Initialize-VcfStorageContainer -Id "MyId" -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" -ClusterId "MyClusterId" $VasaUser = Initialize-VcfVasaUser -Id "MyId" -Username "MyUsername" -Password "MyPassword" $VasaProvider = Initialize-VcfVasaProvider -Id "MyId" -Name "MyName" -Url "MyUrl" -StorageContainers $StorageContainer -Users $VasaUser Invoke-VcfAddVasaProvider -vasaProvider $vasaProvider </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddVasaProvider with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StorageContainer = Initialize-VcfStorageContainer -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" $VasaUser = Initialize-VcfVasaUser -Username "MyUsername" -Password "MyPassword" $VasaProvider = Initialize-VcfVasaProvider -Name "MyName" -Url "MyUrl" -StorageContainers $StorageContainer -Users $VasaUser Invoke-VcfAddVasaProvider -vasaProvider $vasaProvider </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddVasaProvider with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVasaProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddVasaProviderStorageContainer</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddVasaProviderStorageContainer</command:noun> <maml:description> <maml:para>Add the storage containers to a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddVasaProviderStorageContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainer</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<StorageContainer></command:parameterValue> <dev:type> <maml:name>List<StorageContainer></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainer</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<StorageContainer></command:parameterValue> <dev:type> <maml:name>List<StorageContainer></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VasaProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StorageContainer = Initialize-VcfStorageContainer -Id "MyId" -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" -ClusterId "MyClusterId" Invoke-VcfAddVasaProviderStorageContainer -id "Myid" -storageContainer $storageContainer </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddVasaProviderStorageContainer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StorageContainer = Initialize-VcfStorageContainer -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" Invoke-VcfAddVasaProviderStorageContainer -id "Myid" -storageContainer $storageContainer </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddVasaProviderStorageContainer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/storage-containers/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfAddVasaProviderUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfAddVasaProviderUser</command:noun> <maml:description> <maml:para>Add the users to a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfAddVasaProviderUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaUser</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VasaUser></command:parameterValue> <dev:type> <maml:name>List<VasaUser></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaUser</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VasaUser></command:parameterValue> <dev:type> <maml:name>List<VasaUser></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VasaProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VasaUser = Initialize-VcfVasaUser -Id "MyId" -Username "MyUsername" -Password "MyPassword" Invoke-VcfAddVasaProviderUser -id "Myid" -vasaUser $vasaUser </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddVasaProviderUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VasaUser = Initialize-VcfVasaUser -Username "MyUsername" -Password "MyPassword" Invoke-VcfAddVasaProviderUser -id "Myid" -vasaUser $vasaUser </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfAddVasaProviderUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/users/post/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVasaProvider</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVasaProvider</command:noun> <maml:description> <maml:para>Get a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVasaProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VasaProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProvider -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProvider with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProvider -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProvider with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVasaProviderStorageContainers</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVasaProviderStorageContainers</command:noun> <maml:description> <maml:para>Get the storage containers of a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVasaProviderStorageContainers</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProtocolType</maml:name> <maml:Description> <maml:para>Pass an optional Storage Protocol type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProtocolType</maml:name> <maml:Description> <maml:para>Pass an optional Storage Protocol type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<StorageContainer></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProviderStorageContainers -id "Myid" -protocolType "MyprotocolType" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProviderStorageContainers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProviderStorageContainers -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProviderStorageContainers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/storage-containers/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVasaProviderUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVasaProviderUser</command:noun> <maml:description> <maml:para>Get the users of a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVasaProviderUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<VasaUser></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProviderUser -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProviderUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProviderUser -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProviderUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/users/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVasaProviderValidation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVasaProviderValidation</command:noun> <maml:description> <maml:para>Get the status of the validation of the VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVasaProviderValidation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The validation ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProviderValidation -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProviderValidation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProviderValidation -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProviderValidation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/validations/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVasaProviders</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVasaProviders</command:noun> <maml:description> <maml:para>Get the VASA Providers</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVasaProviders</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVasaProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProviders </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProviders with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVasaProviders </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVasaProviders with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRemoveVasaProvider</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRemoveVasaProvider</command:noun> <maml:description> <maml:para>Delete a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRemoveVasaProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveVasaProvider -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveVasaProvider with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveVasaProvider -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveVasaProvider with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfRemoveVasaProviderStorageContainer</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfRemoveVasaProviderStorageContainer</command:noun> <maml:description> <maml:para>Delete a storage container of a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfRemoveVasaProviderStorageContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainerId</maml:name> <maml:Description> <maml:para>Storage container ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainerId</maml:name> <maml:Description> <maml:para>Storage container ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveVasaProviderStorageContainer -id "Myid" -storageContainerId "MystorageContainerId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveVasaProviderStorageContainer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfRemoveVasaProviderStorageContainer -id "Myid" -storageContainerId "MystorageContainerId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfRemoveVasaProviderStorageContainer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/storage-containers/storagecontainerid/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateVasaProvider</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateVasaProvider</command:noun> <maml:description> <maml:para>Update a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateVasaProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProviderUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaProviderUpdateSpec</command:parameterValue> <dev:type> <maml:name>VasaProviderUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProviderUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaProviderUpdateSpec</command:parameterValue> <dev:type> <maml:name>VasaProviderUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VasaProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VasaProviderUpdateSpec = Initialize-VcfVasaProviderUpdateSpec -Name "MyName" -Url "MyUrl" Invoke-VcfUpdateVasaProvider -id "Myid" -vasaProviderUpdateSpec $vasaProviderUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVasaProvider with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VasaProviderUpdateSpec = Initialize-VcfVasaProviderUpdateSpec Invoke-VcfUpdateVasaProvider -id "Myid" -vasaProviderUpdateSpec $vasaProviderUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVasaProvider with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVasaProviderUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateVasaProviderStorageContainer</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateVasaProviderStorageContainer</command:noun> <maml:description> <maml:para>Update the storage container of a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateVasaProviderStorageContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainerId</maml:name> <maml:Description> <maml:para>Storage container ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainerUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">StorageContainerUpdateSpec</command:parameterValue> <dev:type> <maml:name>StorageContainerUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainerId</maml:name> <maml:Description> <maml:para>Storage container ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainerUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">StorageContainerUpdateSpec</command:parameterValue> <dev:type> <maml:name>StorageContainerUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VasaProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StorageContainerUpdateSpec = Initialize-VcfStorageContainerUpdateSpec -Name "MyName" Invoke-VcfUpdateVasaProviderStorageContainer -id "Myid" -storageContainerId "MystorageContainerId" -storageContainerUpdateSpec $storageContainerUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVasaProviderStorageContainer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StorageContainerUpdateSpec = Initialize-VcfStorageContainerUpdateSpec -Name "MyName" Invoke-VcfUpdateVasaProviderStorageContainer -id "Myid" -storageContainerId "MystorageContainerId" -storageContainerUpdateSpec $storageContainerUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVasaProviderStorageContainer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/storage-containers/storagecontainerid/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfStorageContainerUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateVasaProviderUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateVasaProviderUser</command:noun> <maml:description> <maml:para>Update the user of a VASA Provider</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateVasaProviderUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>User ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaUserUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaUserUpdateSpec</command:parameterValue> <dev:type> <maml:name>VasaUserUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VASA Provider ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>User ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaUserUpdateSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaUserUpdateSpec</command:parameterValue> <dev:type> <maml:name>VasaUserUpdateSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VasaProvider</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VasaUserUpdateSpec = Initialize-VcfVasaUserUpdateSpec -Username "MyUsername" -Password "MyPassword" Invoke-VcfUpdateVasaProviderUser -id "Myid" -userId "MyuserId" -vasaUserUpdateSpec $vasaUserUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVasaProviderUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VasaUserUpdateSpec = Initialize-VcfVasaUserUpdateSpec Invoke-VcfUpdateVasaProviderUser -id "Myid" -userId "MyuserId" -vasaUserUpdateSpec $vasaUserUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVasaProviderUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/id/users/userid/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVasaUserUpdateSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfValidateVasaProviderSpec</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfValidateVasaProviderSpec</command:noun> <maml:description> <maml:para>Validate VasaProvider input specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfValidateVasaProviderSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProvider</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaProvider</command:parameterValue> <dev:type> <maml:name>VasaProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProvider</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaProvider</command:parameterValue> <dev:type> <maml:name>VasaProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Validation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StorageContainer = Initialize-VcfStorageContainer -Id "MyId" -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" -ClusterId "MyClusterId" $VasaUser = Initialize-VcfVasaUser -Id "MyId" -Username "MyUsername" -Password "MyPassword" $VasaProvider = Initialize-VcfVasaProvider -Id "MyId" -Name "MyName" -Url "MyUrl" -StorageContainers $StorageContainer -Users $VasaUser Invoke-VcfValidateVasaProviderSpec -vasaProvider $vasaProvider </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateVasaProviderSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StorageContainer = Initialize-VcfStorageContainer -Name "MyName" -ProtocolType "One among: ISCSI, FC, NFS" $VasaUser = Initialize-VcfVasaUser -Username "MyUsername" -Password "MyPassword" $VasaProvider = Initialize-VcfVasaProvider -Name "MyName" -Url "MyUrl" -StorageContainers $StorageContainer -Users $VasaUser Invoke-VcfValidateVasaProviderSpec -vasaProvider $vasaProvider </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfValidateVasaProviderSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vasa-providers/validations/post/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVasaProvider</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVasaProviderSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VasaProviderSpec</command:noun> <maml:description> <maml:para>This specification contains cluster storage configuration for vVol</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains cluster storage configuration for vVol</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVasaProviderSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProviderId</maml:name> <maml:Description> <maml:para>UUID of the VASA storage provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainerId</maml:name> <maml:Description> <maml:para>UUID of the VASA storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageProtocolType</maml:name> <maml:Description> <maml:para>Type of the VASA storage protocol</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>UUID of the VASA storage user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProviderId</maml:name> <maml:Description> <maml:para>UUID of the VASA storage provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageContainerId</maml:name> <maml:Description> <maml:para>UUID of the VASA storage container</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageProtocolType</maml:name> <maml:Description> <maml:para>Type of the VASA storage protocol</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>UUID of the VASA storage user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaProviderSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaProviderSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VasaProviderSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVasaProviderUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VasaProviderUpdateSpec</command:noun> <maml:description> <maml:para>VASA Provider update data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>VASA Provider update data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVasaProviderUpdateSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>URL of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>URL of the VASA Provider</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VasaProviderUpdateSpec = Initialize-VcfVasaProviderUpdateSpec -Name "MyName" -Url "MyUrl" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaProviderUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VasaProviderUpdateSpec = Initialize-VcfVasaProviderUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaProviderUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VasaProviderUpdateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVasaUser</command:name> <command:verb>Initialize</command:verb> <command:noun>VasaUser</command:noun> <maml:description> <maml:para>VASA User representation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>VASA User representation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVasaUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the VASA User</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>VASA User name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the VASA User</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>VASA User name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VasaUser = Initialize-VcfVasaUser -Id "MyId" -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VasaUser = Initialize-VcfVasaUser -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VasaUser</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVasaUserUpdateSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VasaUserUpdateSpec</command:noun> <maml:description> <maml:para>User update data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>User update data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVasaUserUpdateSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>VASA User name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>VASA User name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VasaUserUpdateSpec = Initialize-VcfVasaUserUpdateSpec -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaUserUpdateSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VasaUserUpdateSpec = Initialize-VcfVasaUserUpdateSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVasaUserUpdateSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VasaUserUpdateSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVcenter</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVcenter</command:noun> <maml:description> <maml:para>Retrieve a vCenter Server by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVcenter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>vCenter ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>vCenter ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Vcenter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVcenter -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVcenter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVcenter -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVcenter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vcenters/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVcenters</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVcenters</command:noun> <maml:description> <maml:para>Retrieve a list of vCenter Servers</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVcenters</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>ID of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>ID of the domain</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVcenter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVcenters -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVcenters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVcenters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVcenters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vcenters/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVcenterSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VcenterSpec</command:noun> <maml:description> <maml:para>This specification contains the installation and configuration of vCenter in a workload domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the installation and configuration of vCenter in a workload domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVcenterSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the vCenter virtual machine</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkDetailsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkDetailsSpec</command:parameterValue> <dev:type> <maml:name>NetworkDetailsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RootPassword</maml:name> <maml:Description> <maml:para>vCenter root shell password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatacenterName</maml:name> <maml:Description> <maml:para>vCenter datacenter name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmSize</maml:name> <maml:Description> <maml:para>VCenter VM size</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageSize</maml:name> <maml:Description> <maml:para>VCenter storage size</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the vCenter virtual machine</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkDetailsSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkDetailsSpec</command:parameterValue> <dev:type> <maml:name>NetworkDetailsSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RootPassword</maml:name> <maml:Description> <maml:para>vCenter root shell password</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatacenterName</maml:name> <maml:Description> <maml:para>vCenter datacenter name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmSize</maml:name> <maml:Description> <maml:para>VCenter VM size</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StorageSize</maml:name> <maml:Description> <maml:para>VCenter storage size</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -IpAddress "MyIpAddress" -DnsName "MyDnsName" -Gateway "MyGateway" -SubnetMask "MySubnetMask" $VcenterSpec = Initialize-VcfVcenterSpec -Name "MyName" -NetworkDetailsSpec $NetworkDetailsSpec -RootPassword "MyRootPassword" -DatacenterName "MyDatacenterName" -VmSize "One among:xlarge, large, medium, small, tiny" -StorageSize "One among:lstorage, xlstorage" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVcenterSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NetworkDetailsSpec = Initialize-VcfNetworkDetailsSpec -DnsName "MyDnsName" $VcenterSpec = Initialize-VcfVcenterSpec -NetworkDetailsSpec $NetworkDetailsSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVcenterSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VcenterSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNetworkDetailsSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVcenterUpgradeUserInputSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VcenterUpgradeUserInputSpec</command:noun> <maml:description> <maml:para>vCenter Upgrade User Input Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>vCenter Upgrade User Input Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVcenterUpgradeUserInputSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TemporaryNetwork</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TemporaryNetwork</command:parameterValue> <dev:type> <maml:name>TemporaryNetwork</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TemporaryNetwork</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TemporaryNetwork</command:parameterValue> <dev:type> <maml:name>TemporaryNetwork</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $TemporaryNetwork = Initialize-VcfTemporaryNetwork -IpAddress "MyIpAddress" -SubnetMask "MySubnetMask" -Gateway "MyGateway" $VcenterUpgradeUserInputSpec = Initialize-VcfVcenterUpgradeUserInputSpec -TemporaryNetwork $TemporaryNetwork </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVcenterUpgradeUserInputSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $TemporaryNetwork = Initialize-VcfTemporaryNetwork -IpAddress "MyIpAddress" -SubnetMask "MySubnetMask" -Gateway "MyGateway" $VcenterUpgradeUserInputSpec = Initialize-VcfVcenterUpgradeUserInputSpec -TemporaryNetwork $TemporaryNetwork </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVcenterUpgradeUserInputSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VcenterUpgradeUserInputSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfTemporaryNetwork</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVcfService</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVcfService</command:noun> <maml:description> <maml:para>Retrieve an SDDC Manager service by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVcfService</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VcfService ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VcfService ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VcfService</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVcfService -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVcfService with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVcfService -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVcfService with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vcf-services/id/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVcfServices</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVcfServices</command:noun> <maml:description> <maml:para>Retrieve a list of SDDC Manager services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVcfServices</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVcfService</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVcfServices </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVcfServices with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVcfServices </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVcfServices with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vcf-services/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVdsDetail</command:name> <command:verb>Initialize</command:verb> <command:noun>VdsDetail</command:noun> <maml:description> <maml:para>This specification contains the details of vSphere Distributed Switch to be imported to the inventory</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains the details of vSphere Distributed Switch to be imported to the inventory</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVdsDetail</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsName</maml:name> <maml:Description> <maml:para>vSphere Distributed Switch name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsName</maml:name> <maml:Description> <maml:para>vSphere Distributed Switch name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VdsDetail = Initialize-VcfVdsDetail -VdsName "MyVdsName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVdsDetail with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VdsDetail = Initialize-VcfVdsDetail -VdsName "MyVdsName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVdsDetail with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VdsDetail</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVdsSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VdsSpec</command:noun> <maml:description> <maml:para>This specification contains vSphere distributed switch configurations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains vSphere distributed switch configurations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVdsSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>vSphere Distributed Switch name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsUsedByNsxt</maml:name> <maml:Description> <maml:para>Boolean to identify if the vSphere distributed switch is used by NSX. This property is deprecated in favor of nsxtSwitchConfig field</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtSwitchConfig</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxtSwitchConfig</command:parameterValue> <dev:type> <maml:name>NsxtSwitchConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PortGroupSpecs</maml:name> <maml:Description> <maml:para>List of portgroups to be associated with the vSphere Distributed Switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<PortgroupSpec></command:parameterValue> <dev:type> <maml:name>List<PortgroupSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NiocBandwidthAllocationSpecs</maml:name> <maml:Description> <maml:para>List of Network I/O Control Bandwidth Allocations for System Traffic Based on shares, reservation, and limit, you can configure Network I/O Control to allocate certain amount of bandwidth for traffic generated by vSphere Fault Tolerance, iSCSI storage, vSphere vMotion, and so on. You can use Network I/O Control on a distributed switch to configure bandwidth allocation for the traffic that is related to the main system features in vSphere</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NiocBandwidthAllocationSpec></command:parameterValue> <dev:type> <maml:name>List<NiocBandwidthAllocationSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mtu</maml:name> <maml:Description> <maml:para>The maximum transmission unit (MTU) configured for the uplinks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>vSphere Distributed Switch name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsUsedByNsxt</maml:name> <maml:Description> <maml:para>Boolean to identify if the vSphere distributed switch is used by NSX. This property is deprecated in favor of nsxtSwitchConfig field</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtSwitchConfig</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NsxtSwitchConfig</command:parameterValue> <dev:type> <maml:name>NsxtSwitchConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PortGroupSpecs</maml:name> <maml:Description> <maml:para>List of portgroups to be associated with the vSphere Distributed Switch</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<PortgroupSpec></command:parameterValue> <dev:type> <maml:name>List<PortgroupSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NiocBandwidthAllocationSpecs</maml:name> <maml:Description> <maml:para>List of Network I/O Control Bandwidth Allocations for System Traffic Based on shares, reservation, and limit, you can configure Network I/O Control to allocate certain amount of bandwidth for traffic generated by vSphere Fault Tolerance, iSCSI storage, vSphere vMotion, and so on. You can use Network I/O Control on a distributed switch to configure bandwidth allocation for the traffic that is related to the main system features in vSphere</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NiocBandwidthAllocationSpec></command:parameterValue> <dev:type> <maml:name>List<NiocBandwidthAllocationSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Mtu</maml:name> <maml:Description> <maml:para>The maximum transmission unit (MTU) configured for the uplinks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $TransportZone = Initialize-VcfTransportZone -Name "MyName" -TransportType "One among: VLAN, OVERLAY" $NsxtSwitchConfig = Initialize-VcfNsxtSwitchConfig -TransportZones $TransportZone -HostSwitchOperationalMode "One among: STANDARD, ENS, ENS_INTERRUPT" $PortgroupSpec = Initialize-VcfPortgroupSpec -Name "MyName" -TransportType "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT, VSAN_EXTERNAL" -ActiveUplinks "MyActiveUplinks" -StandByUplinks "MyStandByUplinks" -TeamingPolicy "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased" $SharesInfo = Initialize-VcfSharesInfo -Shares 0 -Level "One among: low, normal, high, custom" $NiocTrafficResourceAllocation = Initialize-VcfNiocTrafficResourceAllocation -Limit 0 -SharesInfo $SharesInfo -Reservation 0 $NiocBandwidthAllocationSpec = Initialize-VcfNiocBandwidthAllocationSpec -Type "MyType" -NiocTrafficResourceAllocation $NiocTrafficResourceAllocation $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" -IsUsedByNsxt $false -NsxtSwitchConfig $NsxtSwitchConfig -PortGroupSpecs $PortgroupSpec -NiocBandwidthAllocationSpecs $NiocBandwidthAllocationSpec -Mtu 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVdsSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VdsSpec = Initialize-VcfVdsSpec -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVdsSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VdsSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfNsxtSwitchConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVersionAliasesForBundleComponentType</command:name> <command:verb>Initialize</command:verb> <command:noun>VersionAliasesForBundleComponentType</command:noun> <maml:description> <maml:para>Version Alias representation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Version Alias representation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVersionAliasesForBundleComponentType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleComponentType</maml:name> <maml:Description> <maml:para>Bundle Component Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionAliases</maml:name> <maml:Description> <maml:para>Version Aliases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BaseAlias></command:parameterValue> <dev:type> <maml:name>List<BaseAlias></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleComponentType</maml:name> <maml:Description> <maml:para>Bundle Component Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionAliases</maml:name> <maml:Description> <maml:para>Version Aliases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<BaseAlias></command:parameterValue> <dev:type> <maml:name>List<BaseAlias></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BaseAlias = Initialize-VcfBaseAlias -_Version "My_Version" -Aliases "MyAliases" $VersionAliasesForBundleComponentType = Initialize-VcfVersionAliasesForBundleComponentType -BundleComponentType "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, " -VersionAliases $BaseAlias </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVersionAliasesForBundleComponentType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BaseAlias = Initialize-VcfBaseAlias -_Version "My_Version" -Aliases "MyAliases" $VersionAliasesForBundleComponentType = Initialize-VcfVersionAliasesForBundleComponentType -BundleComponentType "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, " -VersionAliases $BaseAlias </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVersionAliasesForBundleComponentType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VersionAliasesForBundleComponentType</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteAliasVersionsBySoftwareTypeAndBaseVersion</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteAliasVersionsBySoftwareTypeAndBaseVersion</command:noun> <maml:description> <maml:para>Removes Version Alias Configuration by component type and version</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete Version Alias Configuration by bundle component type, version, and aliases.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteAliasVersionsBySoftwareTypeAndBaseVersion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleComponentType</maml:name> <maml:Description> <maml:para>Bundle Component Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Version</maml:name> <maml:Description> <maml:para>Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RequestBody</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleComponentType</maml:name> <maml:Description> <maml:para>Bundle Component Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Version</maml:name> <maml:Description> <maml:para>Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RequestBody</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteAliasVersionsBySoftwareTypeAndBaseVersion -bundleComponentType "MybundleComponentType" -version "Myversion" -requestBody "MyrequestBody" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteAliasVersionsBySoftwareTypeAndBaseVersion with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteAliasVersionsBySoftwareTypeAndBaseVersion -bundleComponentType "MybundleComponentType" -version "Myversion" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteAliasVersionsBySoftwareTypeAndBaseVersion with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/settings/version-aliases/bundlecomponenttype/version/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDeleteVersionAliasBySoftwareType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDeleteVersionAliasBySoftwareType</command:noun> <maml:description> <maml:para>Removes Version Alias Configuration by component type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes Version Alias Configuration by component type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDeleteVersionAliasBySoftwareType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleComponentType</maml:name> <maml:Description> <maml:para>Bundle Component Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleComponentType</maml:name> <maml:Description> <maml:para>Bundle Component Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteVersionAliasBySoftwareType -bundleComponentType "MybundleComponentType" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteVersionAliasBySoftwareType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDeleteVersionAliasBySoftwareType -bundleComponentType "MybundleComponentType" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDeleteVersionAliasBySoftwareType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/settings/version-aliases/bundlecomponenttype/delete/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVersionAliasConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVersionAliasConfiguration</command:noun> <maml:description> <maml:para>Retrieve Version Alias Configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Version Alias Configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVersionAliasConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVersionAliasesForBundleComponentType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVersionAliasConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVersionAliasConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVersionAliasConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVersionAliasConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/settings/version-aliases/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateVersionAliasConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateVersionAliasConfiguration</command:noun> <maml:description> <maml:para>Update the Version Alias Configuration by component type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update Version Alias Configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateVersionAliasConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleComponentType</maml:name> <maml:Description> <maml:para>Bundle Component Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Version</maml:name> <maml:Description> <maml:para>Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AliasSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AliasSpec</command:parameterValue> <dev:type> <maml:name>AliasSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BundleComponentType</maml:name> <maml:Description> <maml:para>Bundle Component Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Version</maml:name> <maml:Description> <maml:para>Version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AliasSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AliasSpec</command:parameterValue> <dev:type> <maml:name>AliasSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVersionAliasesForBundleComponentType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AliasSpec = Initialize-VcfAliasSpec -Aliases "MyAliases" -ForceUpdate $false Invoke-VcfUpdateVersionAliasConfiguration -bundleComponentType "MybundleComponentType" -version "Myversion" -aliasSpec $aliasSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVersionAliasConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AliasSpec = Initialize-VcfAliasSpec -Aliases "MyAliases" Invoke-VcfUpdateVersionAliasConfiguration -bundleComponentType "MybundleComponentType" -version "Myversion" -aliasSpec $aliasSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVersionAliasConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/settings/version-aliases/bundlecomponenttype/version/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfAliasSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateVersionAliasConfigurations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateVersionAliasConfigurations</command:noun> <maml:description> <maml:para>Update Version Alias Configurations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update Version Alias Configurations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateVersionAliasConfigurations</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionAliasesForBundleComponentTypeSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VersionAliasesForBundleComponentTypeSpec</command:parameterValue> <dev:type> <maml:name>VersionAliasesForBundleComponentTypeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionAliasesForBundleComponentTypeSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VersionAliasesForBundleComponentTypeSpec</command:parameterValue> <dev:type> <maml:name>VersionAliasesForBundleComponentTypeSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfVersionAliasesForBundleComponentType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BaseAlias = Initialize-VcfBaseAlias -_Version "My_Version" -Aliases "MyAliases" $VersionAliasesForBundleComponentType = Initialize-VcfVersionAliasesForBundleComponentType -BundleComponentType "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, " -VersionAliases $BaseAlias $VersionAliasesForBundleComponentTypeSpec = Initialize-VcfVersionAliasesForBundleComponentTypeSpec -VersionAliasesForBundleComponentTypes $VersionAliasesForBundleComponentType -ForceUpdate $false -TargetVcfVersion "MyTargetVcfVersion" Invoke-VcfUpdateVersionAliasConfigurations -versionAliasesForBundleComponentTypeSpec $versionAliasesForBundleComponentTypeSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVersionAliasConfigurations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VersionAliasesForBundleComponentTypeSpec = Initialize-VcfVersionAliasesForBundleComponentTypeSpec Invoke-VcfUpdateVersionAliasConfigurations -versionAliasesForBundleComponentTypeSpec $versionAliasesForBundleComponentTypeSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVersionAliasConfigurations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/system/settings/version-aliases/put/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVersionAliasesForBundleComponentTypeSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVersionAliasesForBundleComponentTypeSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VersionAliasesForBundleComponentTypeSpec</command:noun> <maml:description> <maml:para>Version Alias Configuration Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Version Alias Configuration Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVersionAliasesForBundleComponentTypeSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionAliasesForBundleComponentTypes</maml:name> <maml:Description> <maml:para>List of version aliases for bundle component types.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VersionAliasesForBundleComponentType></command:parameterValue> <dev:type> <maml:name>List<VersionAliasesForBundleComponentType></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceUpdate</maml:name> <maml:Description> <maml:para>Flag for force update version alias configuration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVcfVersion</maml:name> <maml:Description> <maml:para>If this field is set, LCM will calculate and update version aliases based on current deployment VCF version and the provided target VCF version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VersionAliasesForBundleComponentTypes</maml:name> <maml:Description> <maml:para>List of version aliases for bundle component types.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VersionAliasesForBundleComponentType></command:parameterValue> <dev:type> <maml:name>List<VersionAliasesForBundleComponentType></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceUpdate</maml:name> <maml:Description> <maml:para>Flag for force update version alias configuration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVcfVersion</maml:name> <maml:Description> <maml:para>If this field is set, LCM will calculate and update version aliases based on current deployment VCF version and the provided target VCF version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BaseAlias = Initialize-VcfBaseAlias -_Version "My_Version" -Aliases "MyAliases" $VersionAliasesForBundleComponentType = Initialize-VcfVersionAliasesForBundleComponentType -BundleComponentType "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, " -VersionAliases $BaseAlias $VersionAliasesForBundleComponentTypeSpec = Initialize-VcfVersionAliasesForBundleComponentTypeSpec -VersionAliasesForBundleComponentTypes $VersionAliasesForBundleComponentType -ForceUpdate $false -TargetVcfVersion "MyTargetVcfVersion" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVersionAliasesForBundleComponentTypeSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VersionAliasesForBundleComponentTypeSpec = Initialize-VcfVersionAliasesForBundleComponentTypeSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVersionAliasesForBundleComponentTypeSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VersionAliasesForBundleComponentTypeSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVmfsDatastoreSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VmfsDatastoreSpec</command:noun> <maml:description> <maml:para>Cluster storage configuration for VMFS</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Cluster storage configuration for VMFS</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVmfsDatastoreSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FcSpec</maml:name> <maml:Description> <maml:para>Cluster storage configuration for VMFS on FC</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<FcSpec></command:parameterValue> <dev:type> <maml:name>List<FcSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FcSpec</maml:name> <maml:Description> <maml:para>Cluster storage configuration for VMFS on FC</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<FcSpec></command:parameterValue> <dev:type> <maml:name>List<FcSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $FcSpec = Initialize-VcfFcSpec -DatastoreName "MyDatastoreName" $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec -FcSpec $FcSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVmfsDatastoreSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VmfsDatastoreSpec = Initialize-VcfVmfsDatastoreSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVmfsDatastoreSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VmfsDatastoreSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVmNic</command:name> <command:verb>Initialize</command:verb> <command:noun>VmNic</command:noun> <maml:description> <maml:para>This specification contains vmnic configurations for vSphere host</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains vmnic configurations for vSphere host</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVmNic</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VmNic ID of vSphere host to be associated with VDS, once added to cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsName</maml:name> <maml:Description> <maml:para>VDS name to associate with vSphere host. VDS name must match the cluster's VDS name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MoveToNvds</maml:name> <maml:Description> <maml:para>This flag determines if the vmnic must be on N-VDS. Set this to true for a vmnic that will be moved to N-VDS</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Uplink</maml:name> <maml:Description> <maml:para>Uplink to be associated with vmnic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>VmNic ID of vSphere host to be associated with VDS, once added to cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VdsName</maml:name> <maml:Description> <maml:para>VDS name to associate with vSphere host. VDS name must match the cluster's VDS name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MoveToNvds</maml:name> <maml:Description> <maml:para>This flag determines if the vmnic must be on N-VDS. Set this to true for a vmnic that will be moved to N-VDS</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Uplink</maml:name> <maml:Description> <maml:para>Uplink to be associated with vmnic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" -MoveToNvds $false -Uplink "MyUplink" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVmNic with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VmNic = Initialize-VcfVmNic -Id "MyId" -VdsName "MyVdsName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVmNic with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VmNic</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVMNicInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>VMNicInfo</command:noun> <maml:description> <maml:para>VMNics attached to an ESXi host reference</maml:para> </maml:description> </command:details> <maml:description> <maml:para>VMNics attached to an ESXi host reference</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVMNicInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the VMNic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LinkSpeedMB</maml:name> <maml:Description> <maml:para>VMNic link speed in MB</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsInUse</maml:name> <maml:Description> <maml:para>Status of VMNic if in use or available</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAutoNegotiateSupported</maml:name> <maml:Description> <maml:para>Status of VMNic if auto negotiate is supported or not</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsActive</maml:name> <maml:Description> <maml:para>Status of VMNic if active or inactive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the VMNic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LinkSpeedMB</maml:name> <maml:Description> <maml:para>VMNic link speed in MB</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsInUse</maml:name> <maml:Description> <maml:para>Status of VMNic if in use or available</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsAutoNegotiateSupported</maml:name> <maml:Description> <maml:para>Status of VMNic if auto negotiate is supported or not</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsActive</maml:name> <maml:Description> <maml:para>Status of VMNic if active or inactive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VMNicInfo = Initialize-VcfVMNicInfo -Name "MyName" -LinkSpeedMB 0 -IsInUse $false -IsAutoNegotiateSupported $false -IsActive $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVMNicInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VMNicInfo = Initialize-VcfVMNicInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVMNicInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VMNicInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVrslcm</command:name> <command:verb>Initialize</command:verb> <command:noun>Vrslcm</command:noun> <maml:description> <maml:para>This specification contains information related to the existing VMware Aria Suite Lifecycle instance deployment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains information related to the existing VMware Aria Suite Lifecycle instance deployment</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVrslcm</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the VMware Aria Suite Lifecycle Manager instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>Fully Qualified Domain Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP Address of VMware Aria Suite Lifecycle Manager appliance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Version of the product that is currently running on the environment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The state of the current product instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the VMware Aria Suite Lifecycle Manager instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>Fully Qualified Domain Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP Address of VMware Aria Suite Lifecycle Manager appliance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Version of the product that is currently running on the environment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The state of the current product instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Vrslcm = Initialize-VcfVrslcm -Id "MyId" -Fqdn "MyFqdn" -IpAddress "MyIpAddress" -_Version "My_Version" -Status "MyStatus" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVrslcm with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Vrslcm = Initialize-VcfVrslcm -Id "MyId" -Fqdn "MyFqdn" -IpAddress "MyIpAddress" -_Version "My_Version" -Status "MyStatus" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVrslcm with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/Vrslcm</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVrslcmDeploymentSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VrslcmDeploymentSpec</command:noun> <maml:description> <maml:para>VMware Aria Suite Lifecycle Deployment Specification</maml:para> </maml:description> </command:details> <maml:description> <maml:para>VMware Aria Suite Lifecycle Deployment Specification</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVrslcmDeploymentSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>Fully Qualified Domain Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshPassword</maml:name> <maml:Description> <maml:para>The password for a root user of VMware Aria Suite Lifecycle appliance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApiPassword</maml:name> <maml:Description> <maml:para>The password for an admin API/UI user of VMware Aria Suite Lifecycle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtStandaloneTier1Ip</maml:name> <maml:Description> <maml:para>The IP to use for deploying a new standalone Tier-1 router in NSX. This router will be used subsequently for VMware Aria load balancers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>Fully Qualified Domain Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshPassword</maml:name> <maml:Description> <maml:para>The password for a root user of VMware Aria Suite Lifecycle appliance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApiPassword</maml:name> <maml:Description> <maml:para>The password for an admin API/UI user of VMware Aria Suite Lifecycle</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtStandaloneTier1Ip</maml:name> <maml:Description> <maml:para>The IP to use for deploying a new standalone Tier-1 router in NSX. This router will be used subsequently for VMware Aria load balancers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VrslcmDeploymentSpec = Initialize-VcfVrslcmDeploymentSpec -Fqdn "vrslcm.vrack.vsphere.local" -SshPassword "MySshPassword" -ApiPassword "MyApiPassword" -NsxtStandaloneTier1Ip "MyNsxtStandaloneTier1Ip" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVrslcmDeploymentSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VrslcmDeploymentSpec = Initialize-VcfVrslcmDeploymentSpec -Fqdn "vrslcm.vrack.vsphere.local" -SshPassword "MySshPassword" -ApiPassword "MyApiPassword" -NsxtStandaloneTier1Ip "MyNsxtStandaloneTier1Ip" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVrslcmDeploymentSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VrslcmDeploymentSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVsanDatastoreSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VsanDatastoreSpec</command:noun> <maml:description> <maml:para>This specification contains cluster storage configuration for vSAN</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains cluster storage configuration for vSAN</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVsanDatastoreSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>Datastore name used for cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FailuresToTolerate</maml:name> <maml:Description> <maml:para>Number of vSphere host failures to tolerate in the vSAN cluster. This field is required for vSAN OSA configuration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>License key for the vSAN data store to be applied in vCenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DedupAndCompressionEnabled</maml:name> <maml:Description> <maml:para>Enable vSAN deduplication and compression. This features is only available for clusters in which the hosts are all-flash</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsaConfig</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EsaConfig</command:parameterValue> <dev:type> <maml:name>EsaConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>Datastore name used for cluster creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FailuresToTolerate</maml:name> <maml:Description> <maml:para>Number of vSphere host failures to tolerate in the vSAN cluster. This field is required for vSAN OSA configuration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LicenseKey</maml:name> <maml:Description> <maml:para>License key for the vSAN data store to be applied in vCenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DedupAndCompressionEnabled</maml:name> <maml:Description> <maml:para>Enable vSAN deduplication and compression. This features is only available for clusters in which the hosts are all-flash</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EsaConfig</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EsaConfig</command:parameterValue> <dev:type> <maml:name>EsaConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false $EsaConfig = Initialize-VcfEsaConfig -Enabled $false -VsanMaxConfig $VsanMaxConfig $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" -FailuresToTolerate 0 -LicenseKey "MyLicenseKey" -DedupAndCompressionEnabled $false -EsaConfig $EsaConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanDatastoreSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VsanDatastoreSpec = Initialize-VcfVsanDatastoreSpec -DatastoreName "MyDatastoreName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanDatastoreSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VsanDatastoreSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfEsaConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfDownloadVsanHcl</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfDownloadVsanHcl</command:noun> <maml:description> <maml:para>Download vSAN HCL</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Download vSAN HCL if online connectivity is available. Timestamp of vSAN HCL on SDDC Manager is checked with what is available online before download. vSAN HCL is downloaded only if new data is available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfDownloadVsanHcl</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfDownloadVsanHcl </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDownloadVsanHcl with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfDownloadVsanHcl </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfDownloadVsanHcl with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vsan-hcl/patch/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVsanHclAttributes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVsanHclAttributes</command:noun> <maml:description> <maml:para>Get vSAN HCL attributes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Attributes of vSAN HCL data such as timestamp of last update</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVsanHclAttributes</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VsanHclAttributes</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHclAttributes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHclAttributes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHclAttributes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHclAttributes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vsan-hcl/attributes/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVsanHclConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVsanHclConfiguration</command:noun> <maml:description> <maml:para>Get vSAN HCL configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVsanHclConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VsanHclConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHclConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHclConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHclConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHclConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vsan-hcl/configuration/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateVsanHclConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateVsanHclConfiguration</command:noun> <maml:description> <maml:para>Update vSAN HCL configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateVsanHclConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanHclConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VsanHclConfiguration</command:parameterValue> <dev:type> <maml:name>VsanHclConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanHclConfiguration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VsanHclConfiguration</command:parameterValue> <dev:type> <maml:name>VsanHclConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VsanHclConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VsanHclConfiguration = Initialize-VcfVsanHclConfiguration -AutoDownloadEnabled $false -OutOfDateErrorThreshold 0 -OutOfDateWarningThreshold 0 -PollingInterval 0 -PollingEnabled $false Invoke-VcfUpdateVsanHclConfiguration -vsanHclConfiguration $vsanHclConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVsanHclConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VsanHclConfiguration = Initialize-VcfVsanHclConfiguration -AutoDownloadEnabled $false -OutOfDateErrorThreshold 0 -OutOfDateWarningThreshold 0 -PollingInterval 0 -PollingEnabled $false Invoke-VcfUpdateVsanHclConfiguration -vsanHclConfiguration $vsanHclConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVsanHclConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/vsan-hcl/configuration/patch/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVsanHclConfiguration</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVsanHclConfiguration</command:name> <command:verb>Initialize</command:verb> <command:noun>VsanHclConfiguration</command:noun> <maml:description> <maml:para>vSAN HCL configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>vSAN HCL configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVsanHclConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutoDownloadEnabled</maml:name> <maml:Description> <maml:para>Flag to indicate if auto download of vSAN HCL data is enabled or disabled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OutOfDateErrorThreshold</maml:name> <maml:Description> <maml:para>Duration after which vSAN HCL data will be flagged as out of date with severity as error</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OutOfDateWarningThreshold</maml:name> <maml:Description> <maml:para>Duration after which vSAN HCL data will be flagged as out of date with severity as warning</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PollingInterval</maml:name> <maml:Description> <maml:para>Interval in minutes at which availability of new vSAN HCL data will be checked</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PollingEnabled</maml:name> <maml:Description> <maml:para>Flag to indicate if polling for vSAN HCL data is enabled or disabled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutoDownloadEnabled</maml:name> <maml:Description> <maml:para>Flag to indicate if auto download of vSAN HCL data is enabled or disabled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OutOfDateErrorThreshold</maml:name> <maml:Description> <maml:para>Duration after which vSAN HCL data will be flagged as out of date with severity as error</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OutOfDateWarningThreshold</maml:name> <maml:Description> <maml:para>Duration after which vSAN HCL data will be flagged as out of date with severity as warning</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PollingInterval</maml:name> <maml:Description> <maml:para>Interval in minutes at which availability of new vSAN HCL data will be checked</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PollingEnabled</maml:name> <maml:Description> <maml:para>Flag to indicate if polling for vSAN HCL data is enabled or disabled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VsanHclConfiguration = Initialize-VcfVsanHclConfiguration -AutoDownloadEnabled $false -OutOfDateErrorThreshold 0 -OutOfDateWarningThreshold 0 -PollingInterval 0 -PollingEnabled $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanHclConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VsanHclConfiguration = Initialize-VcfVsanHclConfiguration -AutoDownloadEnabled $false -OutOfDateErrorThreshold 0 -OutOfDateWarningThreshold 0 -PollingInterval 0 -PollingEnabled $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanHclConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VsanHclConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVsanHealthCheckByDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVsanHealthCheckByDomain</command:noun> <maml:description> <maml:para>Retrieve vSAN Health Check status for a domain by its ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get vSAN health check status for all cluster on the domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVsanHealthCheckByDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Status of health check to filter by</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>Status of health check to filter by</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HealthCheckQueryResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHealthCheckByDomain -domainId "MydomainId" -status "Mystatus" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHealthCheckByDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHealthCheckByDomain -domainId "MydomainId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHealthCheckByDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/health-checks/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVsanHealthCheckByQueryID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVsanHealthCheckByQueryID</command:noun> <maml:description> <maml:para>Retrieve vSAN Health Check status for a domain and query ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get vSAN health check status for a given Query Id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVsanHealthCheckByQueryID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryId</maml:name> <maml:Description> <maml:para>Query ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HealthCheckQueryResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHealthCheckByQueryID -domainId "MydomainId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHealthCheckByQueryID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHealthCheckByQueryID -domainId "MydomainId" -queryId "MyqueryId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHealthCheckByQueryID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/health-checks/queries/queryid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetVsanHealthCheckByTaskID</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetVsanHealthCheckByTaskID</command:noun> <maml:description> <maml:para>Retrieve a vSAN Health Check by task ID</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get vSAN health check update task status for a given task Id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetVsanHealthCheckByTaskID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Health check task id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Health check task id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HealthCheckTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHealthCheckByTaskID -domainId "MydomainId" -taskId "MytaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHealthCheckByTaskID with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetVsanHealthCheckByTaskID -domainId "MydomainId" -taskId "MytaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetVsanHealthCheckByTaskID with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/health-checks/tasks/taskid/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfUpdateVsanHealthCheckByDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfUpdateVsanHealthCheckByDomain</command:noun> <maml:description> <maml:para>Update the vSAN Health Check status for a domain</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update vSAN health check status for domain</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfUpdateVsanHealthCheckByDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HealthCheckSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HealthCheckSpec></command:parameterValue> <dev:type> <maml:name>List<HealthCheckSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DomainId</maml:name> <maml:Description> <maml:para>Domain ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HealthCheckSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<HealthCheckSpec></command:parameterValue> <dev:type> <maml:name>List<HealthCheckSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HealthCheckTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HealthCheckSpec = Initialize-VcfHealthCheckSpec -Id "MyId" -Name "MyName" -Status "MyStatus" -ResourceType "MyResourceType" -ResourceName "MyResourceName" Invoke-VcfUpdateVsanHealthCheckByDomain -domainId "MydomainId" -healthCheckSpec $healthCheckSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVsanHealthCheckByDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HealthCheckSpec = Initialize-VcfHealthCheckSpec -Id "MyId" -Name "MyName" -Status "MyStatus" -ResourceType "MyResourceType" Invoke-VcfUpdateVsanHealthCheckByDomain -domainId "MydomainId" -healthCheckSpec $healthCheckSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfUpdateVsanHealthCheckByDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/domains/domainid/health-checks/patch/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVsanMaxConfig</command:name> <command:verb>Initialize</command:verb> <command:noun>VsanMaxConfig</command:noun> <maml:description> <maml:para>This spec contains cluster vSAN MAX configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This spec contains cluster vSAN MAX configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVsanMaxConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableVsanMax</maml:name> <maml:Description> <maml:para>Field to enable Vsan Max on the Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnableVsanMax</maml:name> <maml:Description> <maml:para>Field to enable Vsan Max on the Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VsanMaxConfig = Initialize-VcfVsanMaxConfig -EnableVsanMax $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanMaxConfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VsanMaxConfig = Initialize-VcfVsanMaxConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanMaxConfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VsanMaxConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVSANNetworkSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VSANNetworkSpec</command:noun> <maml:description> <maml:para>Contains the vSAN Network details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains the vSAN Network details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVSANNetworkSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanGatewayIP</maml:name> <maml:Description> <maml:para>vSAN Gateway IP of the ESXi host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanCidr</maml:name> <maml:Description> <maml:para>vSAN subnet cidr of the ESXi host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanGatewayIP</maml:name> <maml:Description> <maml:para>vSAN Gateway IP of the ESXi host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanCidr</maml:name> <maml:Description> <maml:para>vSAN subnet cidr of the ESXi host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VSANNetworkSpec = Initialize-VcfVSANNetworkSpec -VsanGatewayIP "MyVsanGatewayIP" -VsanCidr "MyVsanCidr" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVSANNetworkSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VSANNetworkSpec = Initialize-VcfVSANNetworkSpec -VsanGatewayIP "MyVsanGatewayIP" -VsanCidr "MyVsanCidr" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVSANNetworkSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VSANNetworkSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVsanRemoteDatastoreClusterSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VsanRemoteDatastoreClusterSpec</command:noun> <maml:description> <maml:para>vSAN remote datastore configuration for the cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>vSAN remote datastore configuration for the cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVsanRemoteDatastoreClusterSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanRemoteDatastoreSpec</maml:name> <maml:Description> <maml:para>List of Remote vSAN datastore configuration for vSAN compute client cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VsanRemoteDatastoreSpec></command:parameterValue> <dev:type> <maml:name>List<VsanRemoteDatastoreSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanRemoteDatastoreSpec</maml:name> <maml:Description> <maml:para>List of Remote vSAN datastore configuration for vSAN compute client cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VsanRemoteDatastoreSpec></command:parameterValue> <dev:type> <maml:name>List<VsanRemoteDatastoreSpec></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec -VsanRemoteDatastoreSpec $VsanRemoteDatastoreSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanRemoteDatastoreClusterSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VsanRemoteDatastoreClusterSpec = Initialize-VcfVsanRemoteDatastoreClusterSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanRemoteDatastoreClusterSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VsanRemoteDatastoreClusterSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVsanRemoteDatastoreSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VsanRemoteDatastoreSpec</command:noun> <maml:description> <maml:para>This specification contains cluster storage configuration for vSAN</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains cluster storage configuration for vSAN</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVsanRemoteDatastoreSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreUuid</maml:name> <maml:Description> <maml:para>vSAN Remote Datastore UUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreUuid</maml:name> <maml:Description> <maml:para>vSAN Remote Datastore UUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanRemoteDatastoreSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VsanRemoteDatastoreSpec = Initialize-VcfVsanRemoteDatastoreSpec -DatastoreUuid "MyDatastoreUuid" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVsanRemoteDatastoreSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VsanRemoteDatastoreSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVvolDatastoreSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VvolDatastoreSpec</command:noun> <maml:description> <maml:para>This specification contains cluster storage configuration for vVol</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This specification contains cluster storage configuration for vVol</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVvolDatastoreSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the datastore</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProviderSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaProviderSpec</command:parameterValue> <dev:type> <maml:name>VasaProviderSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the datastore</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VasaProviderSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VasaProviderSpec</command:parameterValue> <dev:type> <maml:name>VasaProviderSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVvolDatastoreSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VasaProviderSpec = Initialize-VcfVasaProviderSpec -VasaProviderId "MyVasaProviderId" -StorageContainerId "MyStorageContainerId" -StorageProtocolType "One among: ISCSI, NFS, FC" -UserId "MyUserId" $VvolDatastoreSpec = Initialize-VcfVvolDatastoreSpec -Name "MyName" -VasaProviderSpec $VasaProviderSpec </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVvolDatastoreSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VvolDatastoreSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVasaProviderSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVvsVersionAliases</command:name> <command:verb>Initialize</command:verb> <command:noun>VvsVersionAliases</command:noun> <maml:description> <maml:para>Vvs Mapping rest model that is located in the 2.0 manifest, these models are consumed by AP tool to determine the release Id to vcf version mapping in VVS compatibility data.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Vvs Mapping rest model that is located in the 2.0 manifest, these models are consumed by AP tool to determine the release Id to vcf version mapping in VVS compatibility data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVvsVersionAliases</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Aliases</maml:name> <maml:Description> <maml:para>Product version aliases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Version</maml:name> <maml:Description> <maml:para>Product version</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Aliases</maml:name> <maml:Description> <maml:para>Product version aliases</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VvsVersionAliases = Initialize-VcfVvsVersionAliases -_Version "My_Version" -Aliases "MyAliases" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVvsVersionAliases with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VvsVersionAliases = Initialize-VcfVvsVersionAliases -_Version "My_Version" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVvsVersionAliases with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VvsVersionAliases</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVxRailArrayAssociationContext</command:name> <command:verb>Initialize</command:verb> <command:noun>VxRailArrayAssociationContext</command:noun> <maml:description> <maml:para>Contains the mapping between custom attributes and the supported attributes on the array item object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains the mapping between custom attributes and the supported attributes on the array item object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVxRailArrayAssociationContext</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Parent</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VxRailArrayAssociationContext</command:parameterValue> <dev:type> <maml:name>VxRailArrayAssociationContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ArrayAttributeIdsKeyValue</maml:name> <maml:Description> <maml:para>Key, Value map that holds the simple attributes on the array item that are currently supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Parent</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VxRailArrayAssociationContext</command:parameterValue> <dev:type> <maml:name>VxRailArrayAssociationContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ArrayAttributeIdsKeyValue</maml:name> <maml:Description> <maml:para>Key, Value map that holds the simple attributes on the array item that are currently supported.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, string></command:parameterValue> <dev:type> <maml:name>Dictionary<string, string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVxRailArrayAssociationContext with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVxRailArrayAssociationContext with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VxRailArrayAssociationContext</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVxRailArrayAssociationContext</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVxRailContext</command:name> <command:verb>Initialize</command:verb> <command:noun>VxRailContext</command:noun> <maml:description> <maml:para>Contains VxRail Specific properties</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains VxRail Specific properties</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVxRailContext</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AttributeName</maml:name> <maml:Description> <maml:para>Attribute name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Datatype</maml:name> <maml:Description> <maml:para>Datatype of attribute value</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(DatatypeEnum)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>Attribute value</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AttributeName</maml:name> <maml:Description> <maml:para>Attribute name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Datatype</maml:name> <maml:Description> <maml:para>Datatype of attribute value</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>default(DatatypeEnum)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>Attribute value</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVxRailContext with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VxRailContext = Initialize-VcfVxRailContext </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVxRailContext with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VxRailContext</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVxRailCustomArrayContext</command:name> <command:verb>Initialize</command:verb> <command:noun>VxRailCustomArrayContext</command:noun> <maml:description> <maml:para>Contains the details of simple/complex custom attribute on an array item object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains the details of simple/complex custom attribute on an array item object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVxRailCustomArrayContext</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ArrayAssociationContext</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VxRailArrayAssociationContext</command:parameterValue> <dev:type> <maml:name>VxRailArrayAssociationContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SimpleAttributes</maml:name> <maml:Description> <maml:para>Collection of simple attributes that contains name, value and type for each attribute.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VxRailContext></command:parameterValue> <dev:type> <maml:name>List<VxRailContext></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ArrayAssociationContext</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VxRailArrayAssociationContext</command:parameterValue> <dev:type> <maml:name>VxRailArrayAssociationContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SimpleAttributes</maml:name> <maml:Description> <maml:para>Collection of simple attributes that contains name, value and type for each attribute.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VxRailContext></command:parameterValue> <dev:type> <maml:name>List<VxRailContext></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVxRailCustomArrayContext with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVxRailCustomArrayContext with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VxRailCustomArrayContext</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfVxRailArrayAssociationContext</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfVxRailDetails</command:name> <command:verb>Initialize</command:verb> <command:noun>VxRailDetails</command:noun> <maml:description> <maml:para>Contains the VxRail Manager details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains the VxRail Manager details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfVxRailDetails</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RootCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UnmanagedResourceCredential</command:parameterValue> <dev:type> <maml:name>UnmanagedResourceCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdminCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UnmanagedResourceCredential</command:parameterValue> <dev:type> <maml:name>UnmanagedResourceCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshThumbprint</maml:name> <maml:Description> <maml:para>SSH thumbprint of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SslThumbprint</maml:name> <maml:Description> <maml:para>SSL thumbprint of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Networks</maml:name> <maml:Description> <maml:para>Network details of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Network></command:parameterValue> <dev:type> <maml:name>List<Network></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP Address of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsName</maml:name> <maml:Description> <maml:para>DNS Name/Hostname of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NicProfile</maml:name> <maml:Description> <maml:para>Nic Profile Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContextWithKeyValuePair</maml:name> <maml:Description> <maml:para>Map of Context class with list of key and value pairs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<VxRailContext>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<VxRailContext>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ArrayContextWithKeyValuePair</maml:name> <maml:Description> <maml:para>Map of Context class with list of key and value pairs for array objects</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<VxRailCustomArrayContext>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<VxRailCustomArrayContext>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RootCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UnmanagedResourceCredential</command:parameterValue> <dev:type> <maml:name>UnmanagedResourceCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdminCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UnmanagedResourceCredential</command:parameterValue> <dev:type> <maml:name>UnmanagedResourceCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SshThumbprint</maml:name> <maml:Description> <maml:para>SSH thumbprint of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SslThumbprint</maml:name> <maml:Description> <maml:para>SSL thumbprint of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Networks</maml:name> <maml:Description> <maml:para>Network details of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Network></command:parameterValue> <dev:type> <maml:name>List<Network></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IpAddress</maml:name> <maml:Description> <maml:para>IP Address of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DnsName</maml:name> <maml:Description> <maml:para>DNS Name/Hostname of the VxRail Manager</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NicProfile</maml:name> <maml:Description> <maml:para>Nic Profile Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContextWithKeyValuePair</maml:name> <maml:Description> <maml:para>Map of Context class with list of key and value pairs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<VxRailContext>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<VxRailContext>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ArrayContextWithKeyValuePair</maml:name> <maml:Description> <maml:para>Map of Context class with list of key and value pairs for array objects</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, List<VxRailCustomArrayContext>></command:parameterValue> <dev:type> <maml:name>Dictionary<string, List<VxRailCustomArrayContext>></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $UnmanagedResourceCredential = Initialize-VcfUnmanagedResourceCredential -CredentialType "One among: SSH" -Username "MyUsername" -Password "MyPassword" $IpPool = Initialize-VcfIpPool -Start "MyStart" -End "MyEnd" $Network = Initialize-VcfNetwork -Id "MyId" -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" -IpPools $IpPool -FreeIps "MyFreeIps" -UsedIps "MyUsedIps" $VxRailDetails = Initialize-VcfVxRailDetails -RootCredentials $UnmanagedResourceCredential -AdminCredentials $UnmanagedResourceCredential -SshThumbprint "MySshThumbprint" -SslThumbprint "MySslThumbprint" -Networks $Network -IpAddress "MyIpAddress" -DnsName "MyDnsName" -NicProfile "MyNicProfile" -ContextWithKeyValuePair @{ key_example = $VxRailContext = Initialize-VcfVxRailContext -AttributeName "MyAttributeName" -Datatype "INTEGER" -Value "MyValue" } -ArrayContextWithKeyValuePair @{ key_example = $VxRailArrayAssociationContext = Initialize-VcfVxRailArrayAssociationContext -Parent $VxRailArrayAssociationContext -ArrayAttributeIdsKeyValue @{ key_example = "MyInner" } $VxRailCustomArrayContext = Initialize-VcfVxRailCustomArrayContext -ArrayAssociationContext $VxRailArrayAssociationContext -SimpleAttributes $VxRailContext } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVxRailDetails with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Network = Initialize-VcfNetwork -Type "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL" -VlanId 0 -Mtu 0 -Subnet "MySubnet" -Mask "MyMask" -Gateway "MyGateway" $VxRailDetails = Initialize-VcfVxRailDetails -Networks $Network </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfVxRailDetails with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/VxRailDetails</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfUnmanagedResourceCredential</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfUnmanagedResourceCredential</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfWitnessSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>WitnessSpec</command:noun> <maml:description> <maml:para>Spec contains the Witness host parameters that are part of each stretched cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec contains the Witness host parameters that are part of each stretched cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfWitnessSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanIp</maml:name> <maml:Description> <maml:para>vSAN IP of the witness host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>Management ip of the witness host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanCidr</maml:name> <maml:Description> <maml:para>vSAN subnet cidr of the witness host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanIp</maml:name> <maml:Description> <maml:para>vSAN IP of the witness host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fqdn</maml:name> <maml:Description> <maml:para>Management ip of the witness host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VsanCidr</maml:name> <maml:Description> <maml:para>vSAN subnet cidr of the witness host</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$WitnessSpec = Initialize-VcfWitnessSpec -VsanIp "MyVsanIp" -Fqdn "MyFqdn" -VsanCidr "MyVsanCidr" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfWitnessSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$WitnessSpec = Initialize-VcfWitnessSpec -VsanIp "MyVsanIp" -Fqdn "MyFqdn" -VsanCidr "MyVsanCidr" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfWitnessSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/data-structures/WitnessSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VcfGetWsas</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfGetWsas</command:noun> <maml:description> <maml:para>Retrieve a list of Workspace ONE Access instances</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfGetWsas</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PageOfWsa</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VcfGetWsas </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetWsas with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfGetWsas </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfGetWsas with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.vmware.com/apis/vcf/latest/v1/wsas/get/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |