net472/VMware.Sdk.Vcf.Ops.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>Connect-VcfOpsServer</command:name> <command:verb>Connect</command:verb> <command:noun>VcfOpsServer</command:noun> <maml:description> <maml:para>This cmdlet establishes a connection to a VMware Vcf Operations Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet establishes a connection to a VMware Vcf Operations Server. The resulting connections are added to the list of default connections in a global variable named "$global:defaultOpsConnections" (if the NotDefault switch was not specified).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-VcfOpsServer</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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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 Vcf Operations 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.Ops.Types.VcfOpsServer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsServer -Server MyVcfOps.com -User "User" -Password "Password" Connects to a VMware Vcf Operations server with a MyVcfOps.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-VcfOpsServer -Server MyVcfOps.com -Credential $myCredential Connects to a VMware Vcf Operations server with a MyVcfOps.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-VcfOpsGetActionStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetActionStatus</command:noun> <maml:description> <maml:para>Get action status by the given task Id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The response contains information about the action status by the given taskId</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetActionStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Action identifier (result of the action: POST /api/actions/{id})</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Detail</maml:name> <maml:Description> <maml:para>Information about action status objects</maml:para> </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>TaskId</maml:name> <maml:Description> <maml:para>Action identifier (result of the action: POST /api/actions/{id})</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Detail</maml:name> <maml:Description> <maml:para>Information about action status objects</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.ActionStatusInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetActionStatus -taskId "taskId_example" -detail $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetActionStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetActionStatus -taskId "taskId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetActionStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/actions/taskId/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-VcfOpsGetAllActions</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAllActions</command:noun> <maml:description> <maml:para>Look up Action Definitions in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Performing a <code>GET /api/actiondefinitions</code> call will query for <br/>available Actions defined in the system. This includes the data needed <br/>to populate an <i>Action</i> in the system.<br></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAllActions</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ScheduleEnabled</maml:name> <maml:Description> <maml:para>Filtering action definitions by the availability of being scheduled</maml:para> </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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ScheduleEnabled</maml:name> <maml:Description> <maml:para>Filtering action definitions by the availability of being scheduled</maml:para> </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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ActionDefinitions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAllActions -scheduleEnabled $true -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAllActions with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAllActions </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAllActions with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/actiondefinitions/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-VcfOpsPerformAction</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPerformAction</command:noun> <maml:description> <maml:para>Perform an Action on one or more resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para><br>Performing a <code>POST /api/actions/{id}</code> will attempt to trigger the <br/>action with specified id. It is considered a best practice to use the <i>actionExecution</i> field from the<br/><code>POST /api/action/{id}/query</code> that has been previously executed to populate <br/>the body of the request. Please note that additional values may be required in order to make<br/>the <i>populateAction</i> response body valid.<br></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPerformAction</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 for the action to be executed (can be retrieved via: GET /api/actiondefinitions)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActionExecution</maml:name> <maml:Description> <maml:para>Describe instance data about performing an action.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ActionExecution</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ActionExecution</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 for the action to be executed (can be retrieved via: GET /api/actiondefinitions)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActionExecution</maml:name> <maml:Description> <maml:para>Describe instance data about performing an action.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ActionExecution</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ActionExecution</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StrValues</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $ActionParameterGroup = Initialize-VcfOpsActionParameterGroup -ResourceId "MyResourceId" -ParameterValue $NameValue $ActionExecution = Initialize-VcfOpsActionExecution -ContextId "MyContextId" -ContextResourceId "MyContextResourceId" -ParameterGroup $ActionParameterGroup Invoke-VcfOpsPerformAction -id "id_example" -actionExecution $actionExecution </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPerformAction with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ActionParameterGroup = Initialize-VcfOpsActionParameterGroup -ResourceId "MyResourceId" $ActionExecution = Initialize-VcfOpsActionExecution -ParameterGroup $ActionParameterGroup Invoke-VcfOpsPerformAction -id "id_example" -actionExecution $actionExecution </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPerformAction with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/actions/id/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsactionexecution</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-VcfOpsPopulateAction</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPopulateAction</command:noun> <maml:description> <maml:para>Populate the information needed to run an action</maml:para> </maml:description> </command:details> <maml:description> <maml:para><br>Performing a <code>POST /api/actions/{id}/query</code> would yield a response object that <br/>includes the resources that the action would apply to with the populated values of each action <br/>context field for the resource. The response contains information about the parameters to the <br/>action's method. It also includes a sample input that would be used for running the action with <br/><code>POST /api/actions/{id}</code> if you chose to run it on all applicable resources <br/>and not change the default input values.<br> <br>The json result inside actionExecution can be used directly as input perform the action. In the xml<br/>result, the xml element ops:action-execution will need namespace binding added to it in order to use it <br/>in the request.<br/><code>xmlns:ops=\"http://webservice.vmware.com/vRealizeOpsMgr/1.0/\"</code> <br/></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPopulateAction</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 for the action to be populate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActionPopulation</maml:name> <maml:Description> <maml:para>The additional information needed to populate the action.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ActionPopulation</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ActionPopulation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 for the action to be populate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActionPopulation</maml:name> <maml:Description> <maml:para>The additional information needed to populate the action.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ActionPopulation</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ActionPopulation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PopulatedAction</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ActionPopulation = Initialize-VcfOpsActionPopulation -ContextResourceId "MyContextResourceId" Invoke-VcfOpsPopulateAction -id "id_example" -actionPopulation $actionPopulation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPopulateAction with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ActionPopulation = Initialize-VcfOpsActionPopulation -ContextResourceId "MyContextResourceId" Invoke-VcfOpsPopulateAction -id "id_example" -actionPopulation $actionPopulation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPopulateAction with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/actions/id/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsactionpopulation</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-VcfOpsGetAdapterType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAdapterType</command:noun> <maml:description> <maml:para>Get an Adapter Kind using the specified identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This API provides the Adapter Kinds by passing specified identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAdapterType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Adapter Kind 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>RetrieveResourceKindInfos</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report resource-kind-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>true</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 Adapter Kind 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>RetrieveResourceKindInfos</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report resource-kind-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>true</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterKind</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAdapterType -id "id_example" -retrieveResourceKindInfos $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAdapterType -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapterkinds/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-VcfOpsGetAdapterTypes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAdapterTypes</command:noun> <maml:description> <maml:para>Get Adapter Types</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Adapter Types identified by the specified identifiers or all if 'null' is specified</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAdapterTypes</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>Optional list of identifiers to filter by</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>RetrieveResourceKindInfos</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report resource-kind-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>true</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>Optional list of identifiers to filter by</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>RetrieveResourceKindInfos</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report resource-kind-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>true</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterKinds</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAdapterTypes -adapterKindKey "MyadapterKindKey" -retrieveResourceKindInfos $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterTypes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAdapterTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterTypes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapterkinds/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-VcfOpsGetResourceTypeAttributesForAdapterType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourceTypeAttributesForAdapterType</command:noun> <maml:description> <maml:para>Get the meta-data for attributes (excluding properties) for a specific Resource Kind supported by a specific Adapter Kind</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Supports optional parameters to get specific Resource Type Attributes</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourceTypeAttributesForAdapterType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The Resource Kind 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>AttributeKeys</maml:name> <maml:Description> <maml:para>Optional list of attribute-keys to filter by</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>RetrieveAllLocalizations</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report names in all localizations</maml:para> </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>RetrieveAttributeKeys</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report attribute keys or no.</maml:para> </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>StatOnly</maml:name> <maml:Description> <maml:para>Optional param that indicate whether need to return only stats or stats and properties together</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The Resource Kind 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>AttributeKeys</maml:name> <maml:Description> <maml:para>Optional list of attribute-keys to filter by</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>RetrieveAllLocalizations</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report names in all localizations</maml:para> </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>RetrieveAttributeKeys</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report attribute keys or no.</maml:para> </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>StatOnly</maml:name> <maml:Description> <maml:para>Optional param that indicate whether need to return only stats or stats and properties together</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKindAttributes</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourceTypeAttributesForAdapterType -adapterKindKey "adapterKindKey_example" -resourceKindKey "resourceKindKey_example" -attributeKeys "MyattributeKeys" -retrieveAllLocalizations $false -retrieveAttributeKeys $false -statOnly $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceTypeAttributesForAdapterType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourceTypeAttributesForAdapterType -adapterKindKey "adapterKindKey_example" -resourceKindKey "resourceKindKey_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceTypeAttributesForAdapterType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapterkinds/adapterKindKey/resourcekinds/resourceKindKey/statkeys/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-VcfOpsGetResourceTypeForAdapterType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourceTypeForAdapterType</command:noun> <maml:description> <maml:para>Get a specific Resource Kind supported by a specific Adapter Kind</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a specific Resource Kind supported by a specific Adapter Kind</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourceTypeForAdapterType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The Resource Kind 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The Resource Kind 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKind</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourceTypeForAdapterType -adapterKindKey "adapterKindKey_example" -resourceKindKey "resourceKindKey_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceTypeForAdapterType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourceTypeForAdapterType -adapterKindKey "adapterKindKey_example" -resourceKindKey "resourceKindKey_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceTypeForAdapterType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapterkinds/adapterKindKey/resourcekinds/resourceKindKey/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-VcfOpsGetResourceTypePropertiesForAdapterType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourceTypePropertiesForAdapterType</command:noun> <maml:description> <maml:para>Get the meta-data for properties for a specific Resource Kind supported by a specific Adapter Kind</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Supports optional parameters to get specific Resource Type Properties</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourceTypePropertiesForAdapterType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The Resource Kind 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>Properties</maml:name> <maml:Description> <maml:para>Optional list of property names to filter by</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>RetrieveAllLocalizations</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report names in all localizations</maml:para> </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>RetrieveAttributeKeys</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report attribute keys or no.</maml:para> </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>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The Resource Kind 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>Properties</maml:name> <maml:Description> <maml:para>Optional list of property names to filter by</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>RetrieveAllLocalizations</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report names in all localizations</maml:para> </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>RetrieveAttributeKeys</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report attribute keys or no.</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.ResourceKindAttributes</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourceTypePropertiesForAdapterType -adapterKindKey "adapterKindKey_example" -resourceKindKey "resourceKindKey_example" -properties "Myproperties" -retrieveAllLocalizations $false -retrieveAttributeKeys $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceTypePropertiesForAdapterType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourceTypePropertiesForAdapterType -adapterKindKey "adapterKindKey_example" -resourceKindKey "resourceKindKey_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceTypePropertiesForAdapterType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapterkinds/adapterKindKey/resourcekinds/resourceKindKey/properties/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-VcfOpsGetResourceTypesForAdapterType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourceTypesForAdapterType</command:noun> <maml:description> <maml:para>Get all the Resource Kinds supported by a specific Adapter Kind</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains optional parameter that specifies whether there is a need to report names in all localizations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourceTypesForAdapterType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The identifier of the adapter kind</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetrieveAllLocalizations</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report names in all localizations</maml:para> </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>ResourceKindType</maml:name> <maml:Description> <maml:para>The Category to which a Resource Kind belongs 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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 identifier of the adapter kind</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetrieveAllLocalizations</maml:name> <maml:Description> <maml:para>Optional param that specifies whether need to report names in all localizations</maml:para> </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>ResourceKindType</maml:name> <maml:Description> <maml:para>The Category to which a Resource Kind belongs 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKinds</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourceTypesForAdapterType -key "key_example" -retrieveAllLocalizations $false -resourceKindType "GENERAL" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceTypesForAdapterType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourceTypesForAdapterType -key "key_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceTypesForAdapterType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapterkinds/key/resourcekinds/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-VcfOpsGetResourcesWithAdapterAndResourceKind</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourcesWithAdapterAndResourceKind</command:noun> <maml:description> <maml:para>Query for Resources within a particular Adapter Kind and Resource Kind </maml:para> </maml:description> </command:details> <maml:description> <maml:para>Optionally filter these resources based on resource name. The resource name (specified as a query parameter) will be used for doing a partial match. However, if the resource identifiers and their values are specified, <i>name</i> is ignored and the API enforces all the mandatory (both uniquely identifying and required) identifiers are specified. This allows for looking up a single resource using a ResourceKey and allows the translation between a ResourceKey and a Resource UUID.<br><br>Example how to use the <i>identifiers</i> parameter (currently it cannot be used in our Swagger documentation): <br><i> /api/adapterkinds/{adapterKindKey}/resourcekinds/{resourceKindKey}/resources?identifiers[key1]=value1&identifiers[key2]=value2</i></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourcesWithAdapterAndResourceKind</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The Resource Kind 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>Name</maml:name> <maml:Description> <maml:para>The Resource Name (partial match)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Identifiers</maml:name> <maml:Description> <maml:para>Key,value pairs representing the resource identifiers of a Resource</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The Resource Kind 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>Name</maml:name> <maml:Description> <maml:para>The Resource Name (partial match)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Identifiers</maml:name> <maml:Description> <maml:para>Key,value pairs representing the resource identifiers of a Resource</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Resources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourcesWithAdapterAndResourceKind -adapterKindKey "adapterKindKey_example" -resourceKindKey "resourceKindKey_example" -name "name_example" -identifiers @{ key_example = 0 } -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesWithAdapterAndResourceKind with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourcesWithAdapterAndResourceKind -adapterKindKey "adapterKindKey_example" -resourceKindKey "resourceKindKey_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesWithAdapterAndResourceKind with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapterkinds/adapterKindKey/resourcekinds/resourceKindKey/resources/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-VcfOpsGetResourcesWithAdapterKind</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourcesWithAdapterKind</command:noun> <maml:description> <maml:para>Query for Resources of a particular Adapter Kind</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This API provides the Resources by passing specified Adapter Kind Key</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourcesWithAdapterKind</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Resources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourcesWithAdapterKind -adapterKindKey "adapterKindKey_example" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesWithAdapterKind with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourcesWithAdapterKind -adapterKindKey "adapterKindKey_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesWithAdapterKind with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapterkinds/adapterKindKey/resources/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-VcfOpsCreateAdapterInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateAdapterInstance</command:noun> <maml:description> <maml:para>Create an Adapter Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Pass the not-required parameters to indicate whether need to return default value or null in a result for identifiers that have no/null value in request body and continue instantiating adapter even if no connection is established. <br/>In case of VCenter adapter instance, UI/license extension registration should be run separately.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateAdapterInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreateAdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance creation request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CreateAdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CreateAdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExtractIdentifierDefaults</maml:name> <maml:Description> <maml:para>Indicates whether need to return default value or null in a result for<br/>identifiers that have no/null value in request body</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Proceed with adapter instance creation even if connection is not 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>true</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreateAdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance creation request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CreateAdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CreateAdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExtractIdentifierDefaults</maml:name> <maml:Description> <maml:para>Indicates whether need to return default value or null in a result for<br/>identifiers that have no/null value in request body</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Proceed with adapter instance creation even if connection is not 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>true</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Credential = Initialize-VcfOpsCredential -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" -Fields $NameValue -Editable $false $CreateAdapterInstance = Initialize-VcfOpsCreateAdapterInstance -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -AdapterKindKey "MyAdapterKindKey" -ResourceIdentifiers $NameValue -Credential $Credential -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -PhysicalDatacenterId "MyPhysicalDatacenterId" Invoke-VcfOpsCreateAdapterInstance -createAdapterInstance $createAdapterInstance -extractIdentifierDefaults $false -force $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateAdapterInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CreateAdapterInstance = Initialize-VcfOpsCreateAdapterInstance -Name "MyName" -AdapterKindKey "MyAdapterKindKey" Invoke-VcfOpsCreateAdapterInstance -createAdapterInstance $createAdapterInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateAdapterInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscreateadapterinstance</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-VcfOpsDeleteAdapterInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteAdapterInstance</command:noun> <maml:description> <maml:para>Delete an Adapter Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> Deleting an adapter instance is <em>not synchronous. </em>In case of VCenter adapter instance, UI/license extension un-registration should be run separately.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteAdapterInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>DeleteResources</maml:name> <maml:Description> <maml:para>If set to true, resources discovered by this adapter instance would be deleted as well.</maml:para> </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>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>DeleteResources</maml:name> <maml:Description> <maml:para>If set to true, resources discovered by this adapter instance would be deleted as well.</maml:para> </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-VcfOpsDeleteAdapterInstance -adapterId "adapterId_example" -deleteResources $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAdapterInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteAdapterInstance -adapterId "adapterId_example" -deleteResources $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAdapterInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/adapterId/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-VcfOpsEnumerateAdapterInstances</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsEnumerateAdapterInstances</command:noun> <maml:description> <maml:para>Get all the adapter instance resources in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If Adapter Kind is passed as parameter, the API returns only the instances of that Adapter Kind</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsEnumerateAdapterInstances</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>If this parameter is specified, the API returns only instances of this Adapter Kind.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>If this parameter is specified, the API returns only instances of this Adapter Kind.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstances</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsEnumerateAdapterInstances -adapterKindKey "\"\"" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnumerateAdapterInstances with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsEnumerateAdapterInstances </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnumerateAdapterInstances with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/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-VcfOpsGetAdapterInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAdapterInstance</command:noun> <maml:description> <maml:para>Look up a single adapter instance using an identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a specific adapter instance identified by the specified UUID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAdapterInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance in UUID format.</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>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance in UUID format.</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>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAdapterInstance -adapterId "adapterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAdapterInstance -adapterId "adapterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/adapterId/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-VcfOpsGetResourcesOfAdapterInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourcesOfAdapterInstance</command:noun> <maml:description> <maml:para>Enumerate all resources managed by an adapter instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all resources that are managed by specific Adapter Instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourcesOfAdapterInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Resources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourcesOfAdapterInstance -adapterId "adapterId_example" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesOfAdapterInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourcesOfAdapterInstance -adapterId "adapterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesOfAdapterInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/adapterId/resources/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-VcfOpsMarkAdapterInstanceAsBeingMaintained</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsMarkAdapterInstanceAsBeingMaintained</command:noun> <maml:description> <maml:para>Mark the adapter instance as being MAINTAINED for the given duration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>After the duration expires, the adapter instance state is automatically set to <b>STARTED</b>.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsMarkAdapterInstanceAsBeingMaintained</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>Duration</maml:name> <maml:Description> <maml:para>The duration in minutes for which this resource will not be monitored.</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>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>Duration</maml:name> <maml:Description> <maml:para>The duration in minutes for which this resource will not be monitored.</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>Invoke-VcfOpsMarkAdapterInstanceAsBeingMaintained -adapterId "adapterId_example" -duration 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsMarkAdapterInstanceAsBeingMaintained with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsMarkAdapterInstanceAsBeingMaintained -adapterId "adapterId_example" -duration 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsMarkAdapterInstanceAsBeingMaintained with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/adapterId/maintained/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-VcfOpsPatchAdapterInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPatchAdapterInstance</command:noun> <maml:description> <maml:para>Patch an Adapter Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is typically used to indicate VMware Cloud Foundation operations that the certificates presented by <br/>the (data source for which the adapter instance) was created are indeed valid <br/>certificates. <br/>Typically the response of the <code>POST /api/adapters</code> API in its entirety needs to be <br/>sent as request body when making this <code>PATCH /api/adapters</code> API invocation. <br/><b>NOTE:</b> In case the provided certificate list is empty, the adapter instance self-signed certificates will be reset.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPatchAdapterInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance creation request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance creation request.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AdapterInstance = Initialize-VcfOpsAdapterInstance -ResourceKey $ResourceKey -Description "MyDescription" -CollectorId 0 -CollectorGroupId "MyCollectorGroupId" -CredentialInstanceId "MyCredentialInstanceId" -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -NumberOfMetricsCollected 0 -NumberOfResourcesCollected 0 -LastHeartbeat 0 -LastCollected 0 -MessageFromAdapterInstance "MyMessageFromAdapterInstance" -AdapterCertificates $Certificate -Links $Link -PhysicalDatacenterId "MyPhysicalDatacenterId" -Id "MyId" Invoke-VcfOpsPatchAdapterInstance -adapterInstance $adapterInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchAdapterInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $Certificate = Initialize-VcfOpsCertificate $AdapterInstance = Initialize-VcfOpsAdapterInstance -ResourceKey $ResourceKey -AdapterCertificates $Certificate Invoke-VcfOpsPatchAdapterInstance -adapterInstance $adapterInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchAdapterInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/patch//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsadapterinstance</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-VcfOpsPatchTestConnection</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPatchTestConnection</command:noun> <maml:description> <maml:para>Patch an Adapter Instance Connection</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is typically used to indicate VMware Cloud Foundation operations that the certificates presented by <br/>the (data source for which the adapter instance) was tested are indeed valid <br/>certificates. <br/>Typically the response of the <code>POST /api/adapters</code> API in its entirety needs to be <br/>sent as request body when making this <code>PATCH /api/adapters</code> API invocation. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPatchTestConnection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance connection request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance connection request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AdapterInstance = Initialize-VcfOpsAdapterInstance -ResourceKey $ResourceKey -Description "MyDescription" -CollectorId 0 -CollectorGroupId "MyCollectorGroupId" -CredentialInstanceId "MyCredentialInstanceId" -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -NumberOfMetricsCollected 0 -NumberOfResourcesCollected 0 -LastHeartbeat 0 -LastCollected 0 -MessageFromAdapterInstance "MyMessageFromAdapterInstance" -AdapterCertificates $Certificate -Links $Link -PhysicalDatacenterId "MyPhysicalDatacenterId" -Id "MyId" Invoke-VcfOpsPatchTestConnection -adapterInstance $adapterInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchTestConnection with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $Certificate = Initialize-VcfOpsCertificate $AdapterInstance = Initialize-VcfOpsAdapterInstance -ResourceKey $ResourceKey -AdapterCertificates $Certificate Invoke-VcfOpsPatchTestConnection -adapterInstance $adapterInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchTestConnection with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/testConnection/patch//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsadapterinstance</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-VcfOpsStartMonitoringResourcesOfAdapterInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsStartMonitoringResourcesOfAdapterInstance</command:noun> <maml:description> <maml:para>Start the adapter instance from monitoring its resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start the adapter instance from monitoring its resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsStartMonitoringResourcesOfAdapterInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsStartMonitoringResourcesOfAdapterInstance -adapterId "adapterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStartMonitoringResourcesOfAdapterInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsStartMonitoringResourcesOfAdapterInstance -adapterId "adapterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStartMonitoringResourcesOfAdapterInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/adapterId/monitoringstate/start/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-VcfOpsStopMonitoringResourcesOfAdapterInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsStopMonitoringResourcesOfAdapterInstance</command:noun> <maml:description> <maml:para>Stop the adapter instance from monitoring its resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stop the adapter instance from monitoring its resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsStopMonitoringResourcesOfAdapterInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsStopMonitoringResourcesOfAdapterInstance -adapterId "adapterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStopMonitoringResourcesOfAdapterInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsStopMonitoringResourcesOfAdapterInstance -adapterId "adapterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStopMonitoringResourcesOfAdapterInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/adapterId/monitoringstate/stop/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-VcfOpsTestConnection</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsTestConnection</command:noun> <maml:description> <maml:para>Test Adapter Instance connection</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Test Adapter Instance connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsTestConnection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreateAdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance connection request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CreateAdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CreateAdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreateAdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance connection request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CreateAdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CreateAdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Credential = Initialize-VcfOpsCredential -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" -Fields $NameValue -Editable $false $CreateAdapterInstance = Initialize-VcfOpsCreateAdapterInstance -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -AdapterKindKey "MyAdapterKindKey" -ResourceIdentifiers $NameValue -Credential $Credential -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -PhysicalDatacenterId "MyPhysicalDatacenterId" Invoke-VcfOpsTestConnection -createAdapterInstance $createAdapterInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestConnection with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CreateAdapterInstance = Initialize-VcfOpsCreateAdapterInstance -Name "MyName" -AdapterKindKey "MyAdapterKindKey" Invoke-VcfOpsTestConnection -createAdapterInstance $createAdapterInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestConnection with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/testConnection/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscreateadapterinstance</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-VcfOpsUnmarkAdapterInstanceAsBeingMaintained</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUnmarkAdapterInstanceAsBeingMaintained</command:noun> <maml:description> <maml:para>Mark the adapter instance as being STARTED</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the adapter instance from being in an maintenance window. The adapter instance will be notified to start collection process immediately.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUnmarkAdapterInstanceAsBeingMaintained</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>AdapterId</maml:name> <maml:Description> <maml:para>The identifier of the adapter instance.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsUnmarkAdapterInstanceAsBeingMaintained -adapterId "adapterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnmarkAdapterInstanceAsBeingMaintained with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUnmarkAdapterInstanceAsBeingMaintained -adapterId "adapterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnmarkAdapterInstanceAsBeingMaintained with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/adapterId/maintained/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-VcfOpsUpdateAdapterInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateAdapterInstance</command:noun> <maml:description> <maml:para>Update an Adapter Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The request body can accept a collectorId or a collectorGroupId, but not both.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateAdapterInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance request for the update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterInstance</maml:name> <maml:Description> <maml:para>The adapter instance request for the update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AdapterInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AdapterInstance = Initialize-VcfOpsAdapterInstance -ResourceKey $ResourceKey -Description "MyDescription" -CollectorId 0 -CollectorGroupId "MyCollectorGroupId" -CredentialInstanceId "MyCredentialInstanceId" -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -NumberOfMetricsCollected 0 -NumberOfResourcesCollected 0 -LastHeartbeat 0 -LastCollected 0 -MessageFromAdapterInstance "MyMessageFromAdapterInstance" -AdapterCertificates $Certificate -Links $Link -PhysicalDatacenterId "MyPhysicalDatacenterId" -Id "MyId" Invoke-VcfOpsUpdateAdapterInstance -adapterInstance $adapterInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateAdapterInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $Certificate = Initialize-VcfOpsCertificate $AdapterInstance = Initialize-VcfOpsAdapterInstance -ResourceKey $ResourceKey -AdapterCertificates $Certificate Invoke-VcfOpsUpdateAdapterInstance -adapterInstance $adapterInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateAdapterInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/adapters/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsadapterinstance</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-VcfOpsCreateAlertPlugin</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateAlertPlugin</command:noun> <maml:description> <maml:para>Create a new Notification Plugin Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the Notification plugin is a standard email plugin, then any untrusted certificates from the secure SMTP server <br/>is returned as part of the response, the api client should invoke a PATCH call to store these certificates.<br/>By default the notification plugin is in disabled state after being created.<br/>Use the <code>modifyAlertPluginState</code> API to enable the plugin.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateAlertPlugin</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationPlugin</maml:name> <maml:Description> <maml:para>The NotificationPlugin to create, including plugin type and configuration details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationPlugin</maml:name> <maml:Description> <maml:para>The NotificationPlugin to create, including plugin type and configuration details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $NotificationPlugin = Initialize-VcfOpsNotificationPlugin -PluginTypeId "MyPluginTypeId" -PluginId "MyPluginId" -Name "MyName" -Description "MyDescription" -Enabled $false -ConfigValues $NameValue -Certificates $Certificate Invoke-VcfOpsCreateAlertPlugin -notificationPlugin $notificationPlugin </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateAlertPlugin with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NotificationPlugin = Initialize-VcfOpsNotificationPlugin -PluginTypeId "MyPluginTypeId" -Name "MyName" Invoke-VcfOpsCreateAlertPlugin -notificationPlugin $notificationPlugin </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateAlertPlugin with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsnotificationplugin</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-VcfOpsDeleteAlertPlugin</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteAlertPlugin</command:noun> <maml:description> <maml:para>Delete an existing Notification Plugin Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The field <b>checkDependencies</b> is added to preserve the initial behavior. By default it is set to false.<br/><br/><b>Case 1:</b> When checkDependencies is false, the API has the following behavior:<br/>Dependent Notification Rules are cascade deleted.<br/>Dependent Report Schedules are unreferenced.<br/>Dependent Tenant Email Configurations are always checked. If any then deletion is failed.<br/><br/><b>Case 2:</b> When checkDependencies is true, the API has the following behavior:<br/>All dependencies are checked. If any then deletion is failed.<br/><br/>To successfully delete the notification plugin, all conflicting dependencies must be removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteAlertPlugin</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginId</maml:name> <maml:Description> <maml:para>The identifier of the plugin instance</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>CheckDependencies</maml:name> <maml:Description> <maml:para>Flag to check plugin dependencies</maml:para> </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>PluginId</maml:name> <maml:Description> <maml:para>The identifier of the plugin instance</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>CheckDependencies</maml:name> <maml:Description> <maml:para>Flag to check plugin dependencies</maml:para> </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-VcfOpsDeleteAlertPlugin -pluginId "pluginId_example" -checkDependencies $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAlertPlugin with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteAlertPlugin -pluginId "pluginId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAlertPlugin with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/pluginId/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-VcfOpsGetAlertPluginInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertPluginInstance</command:noun> <maml:description> <maml:para>Get Notification Plugin specified by plugin id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Notification Plugin specified by Plugin ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertPluginInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginId</maml:name> <maml:Description> <maml:para>The identifier for the plugin instance</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>PluginId</maml:name> <maml:Description> <maml:para>The identifier for the plugin instance</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>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertPluginInstance -pluginId "pluginId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertPluginInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertPluginInstance -pluginId "pluginId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertPluginInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/pluginId/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-VcfOpsGetAlertPluginTypeWithId</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertPluginTypeWithId</command:noun> <maml:description> <maml:para>Get the Notification Plugin Type Metadata</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Notification Plugin Type Metadata specified by Plugin Type ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertPluginTypeWithId</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginTypeId</maml:name> <maml:Description> <maml:para>The notification 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>PluginTypeId</maml:name> <maml:Description> <maml:para>The notification 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>VMware.Bindings.Vcf.Ops.Model.AlertPluginType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertPluginTypeWithId -pluginTypeId "pluginTypeId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertPluginTypeWithId with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertPluginTypeWithId -pluginTypeId "pluginTypeId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertPluginTypeWithId with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/types/pluginTypeId/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-VcfOpsGetAlertPluginTypes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertPluginTypes</command:noun> <maml:description> <maml:para>Get the available Notification Plugin Types</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the available Notification Plugin Types</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertPluginTypes</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertPluginTypes</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertPluginTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertPluginTypes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertPluginTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertPluginTypes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/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-VcfOpsGetAlertPluginsOfType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertPluginsOfType</command:noun> <maml:description> <maml:para>Get Notification Plugins, optionally filtered for a specific type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Notification Plugins, optionally filtered for a specific type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertPluginsOfType</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginTypeId</maml:name> <maml:Description> <maml:para>The notification 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>PluginTypeId</maml:name> <maml:Description> <maml:para>The notification 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>VMware.Bindings.Vcf.Ops.Model.NotificationPlugins</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertPluginsOfType -pluginTypeId "pluginTypeId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertPluginsOfType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertPluginsOfType </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertPluginsOfType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/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-VcfOpsGetRulesOfPlugin</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetRulesOfPlugin</command:noun> <maml:description> <maml:para>Retrieve all the notification rules of the plugin instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve all the notification rules of the plugin instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetRulesOfPlugin</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginId</maml:name> <maml:Description> <maml:para>The identifier for the plugin instance</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>PluginId</maml:name> <maml:Description> <maml:para>The identifier for the plugin instance</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>VMware.Bindings.Vcf.Ops.Model.NotificationRules</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetRulesOfPlugin -pluginId "pluginId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRulesOfPlugin with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetRulesOfPlugin -pluginId "pluginId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRulesOfPlugin with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/pluginId/rules/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-VcfOpsModifyAlertPluginState</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsModifyAlertPluginState</command:noun> <maml:description> <maml:para>Start or stop an existing Notification Plugin Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start or stop an existing Notification Plugin Instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsModifyAlertPluginState</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginId</maml:name> <maml:Description> <maml:para>The identifier of the plugin instance</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>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>PluginId</maml:name> <maml:Description> <maml:para>The identifier of the plugin instance</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>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>Invoke-VcfOpsModifyAlertPluginState -pluginId "pluginId_example" -enabled $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyAlertPluginState with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsModifyAlertPluginState -pluginId "pluginId_example" -enabled $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyAlertPluginState with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/pluginId/enable/enabled/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-VcfOpsPatchAlertPlugin</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPatchAlertPlugin</command:noun> <maml:description> <maml:para>Patch a new Notification Plugin Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Patch a new Notification Plugin Instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPatchAlertPlugin</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationPlugin</maml:name> <maml:Description> <maml:para>The NotificationPlugin to create, including plugin type and configuration details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationPlugin</maml:name> <maml:Description> <maml:para>The NotificationPlugin to create, including plugin type and configuration details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $NotificationPlugin = Initialize-VcfOpsNotificationPlugin -PluginTypeId "MyPluginTypeId" -PluginId "MyPluginId" -Name "MyName" -Description "MyDescription" -Enabled $false -ConfigValues $NameValue -Certificates $Certificate Invoke-VcfOpsPatchAlertPlugin -notificationPlugin $notificationPlugin </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchAlertPlugin with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NotificationPlugin = Initialize-VcfOpsNotificationPlugin -PluginTypeId "MyPluginTypeId" -Name "MyName" Invoke-VcfOpsPatchAlertPlugin -notificationPlugin $notificationPlugin </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchAlertPlugin with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/patch//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsnotificationplugin</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-VcfOpsTestAlertPlugin</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsTestAlertPlugin</command:noun> <maml:description> <maml:para>Test existing Notification Plugin Instance connectivity</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Test existing Notification Plugin Instance connectivity</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsTestAlertPlugin</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginId</maml:name> <maml:Description> <maml:para>The identifier of the plugin instance</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>TemplateId</maml:name> <maml:Description> <maml:para>Notification template 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>""</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginId</maml:name> <maml:Description> <maml:para>The identifier of the plugin instance</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>TemplateId</maml:name> <maml:Description> <maml:para>Notification template 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>""</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsTestAlertPlugin -pluginId "pluginId_example" -templateId "\"\"" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestAlertPlugin with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsTestAlertPlugin -pluginId "pluginId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestAlertPlugin with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/pluginId/test/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-VcfOpsUpdateAlertPlugin</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateAlertPlugin</command:noun> <maml:description> <maml:para>Update an existing Notification Plugin Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Before updating a notification plugin, the plugin should be disabled. During the update process<br/>if there are any untrusted certificates returned by the server the patchAlertPlugin call should be made.<br/>Once the update is successfully completed, use <code>modifyAlertPluginState</code> API to enable the plugin.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateAlertPlugin</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationPlugin</maml:name> <maml:Description> <maml:para>The NotificationPlugin to create, including plugin type and configuration details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationPlugin</maml:name> <maml:Description> <maml:para>The NotificationPlugin to create, including plugin type and configuration details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationPlugin</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $NotificationPlugin = Initialize-VcfOpsNotificationPlugin -PluginTypeId "MyPluginTypeId" -PluginId "MyPluginId" -Name "MyName" -Description "MyDescription" -Enabled $false -ConfigValues $NameValue -Certificates $Certificate Invoke-VcfOpsUpdateAlertPlugin -notificationPlugin $notificationPlugin </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateAlertPlugin with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NotificationPlugin = Initialize-VcfOpsNotificationPlugin -PluginTypeId "MyPluginTypeId" -Name "MyName" Invoke-VcfOpsUpdateAlertPlugin -notificationPlugin $notificationPlugin </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateAlertPlugin with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertplugins/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsnotificationplugin</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-VcfOpsAddAlertNote</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddAlertNote</command:noun> <maml:description> <maml:para>Add a Note to an Alert</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Data returned is the Alert Note created in the system. <br/><code> Example: POST /api/alerts/{id}/notes </code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddAlertNote</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The indentifier of the Alert t which the Note need to be added</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>AlertNoteContent</maml:name> <maml:Description> <maml:para>The Content of the note</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertNoteContent</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertNoteContent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 indentifier of the Alert t which the Note need to be added</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>AlertNoteContent</maml:name> <maml:Description> <maml:para>The Content of the note</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertNoteContent</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertNoteContent</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertNote</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AlertNoteContent = Initialize-VcfOpsAlertNoteContent -Content "MyContent" Invoke-VcfOpsAddAlertNote -id "id_example" -alertNoteContent $alertNoteContent </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddAlertNote with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertNoteContent = Initialize-VcfOpsAlertNoteContent -Content "MyContent" Invoke-VcfOpsAddAlertNote -id "id_example" -alertNoteContent $alertNoteContent </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddAlertNote with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/id/notes/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertnotecontent</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-VcfOpsCreateAlertDefinition</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateAlertDefinition</command:noun> <maml:description> <maml:para>Create an Alert Definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Once the Alert Definition is created, a unique identifier will be generated by the system for the Alert Definition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateAlertDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertDefinition</maml:name> <maml:Description> <maml:para>The Alert Definition that needs to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertDefinition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertDefinition</maml:name> <maml:Description> <maml:para>The Alert Definition that needs to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertDefinition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinition</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet $AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" $AlertDefinitionState = Initialize-VcfOpsAlertDefinitionState -Severity "UNKNOWN" -BaseSymptomSet $OneOfSymptomSet -Impact $AlertDefinitionImpact -RecommendationPriorityMap @{ key_example = 0 } $AlertDefinition = Initialize-VcfOpsAlertDefinition -Id "MyId" -Name "MyName" -Description "MyDescription" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -WaitCycles 0 -CancelCycles 0 -Type 0 -SubType 0 -States $AlertDefinitionState -ForVCDTenants $false Invoke-VcfOpsCreateAlertDefinition -alertDefinition $alertDefinition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateAlertDefinition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet $AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" $AlertDefinitionState = Initialize-VcfOpsAlertDefinitionState -Severity "UNKNOWN" -BaseSymptomSet $OneOfSymptomSet -Impact $AlertDefinitionImpact $AlertDefinition = Initialize-VcfOpsAlertDefinition -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -States $AlertDefinitionState Invoke-VcfOpsCreateAlertDefinition -alertDefinition $alertDefinition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateAlertDefinition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertdefinitions/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertdefinition</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-VcfOpsDeleteAlertDefinition</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteAlertDefinition</command:noun> <maml:description> <maml:para>Delete an Alert Definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can delete a particular <i>alert definition</i></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteAlertDefinition</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 Alert Definition to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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 Alert Definition to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteAlertDefinition -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAlertDefinition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteAlertDefinition -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAlertDefinition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertdefinitions/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-VcfOpsDeleteAlertNote</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteAlertNote</command:noun> <maml:description> <maml:para>Delete a specific Alert Note for a specific Alert</maml:para> </maml:description> </command:details> <maml:description> <maml:para><code> Example: DELETE /api/alerts/{id}/notes/{noteId} </code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteAlertNote</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>UUID of the Alert</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>NoteId</maml:name> <maml:Description> <maml:para>Alert Note identifier</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>UUID of the Alert</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>NoteId</maml:name> <maml:Description> <maml:para>Alert Note identifier</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteAlertNote -id "id_example" -noteId "noteId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAlertNote with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteAlertNote -id "id_example" -noteId "noteId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAlertNote with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/id/notes/noteId/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-VcfOpsDeleteCanceledAlerts</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteCanceledAlerts</command:noun> <maml:description> <maml:para>Delete canceled alerts using one or more criteria specified in the Query Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para><br/><code>Example: DELETE /api/alerts/bulk</code><br/></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteCanceledAlerts</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertQuery</maml:name> <maml:Description> <maml:para>The alertQuery criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertQuery</maml:name> <maml:Description> <maml:para>The alertQuery criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $AlertQuery = Initialize-VcfOpsAlertQuery -CompositeOperator "AND" -AlertId "MyAlertId" -AlertName "MyAlertName" -ResourceQuery $ResourceQuery -ActiveOnly $false -AlertTypeSubtype $AlertTypeMapping -AlertCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN" -AlertStatus $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW" -AlertImpact "MyAlertImpact" -AlertDefinitionId "MyAlertDefinitionId" -AlertControlState $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN" -StartTimeRange $TimeRange -UpdateTimeRange $TimeRange -CancelTimeRange $TimeRange -IncludeChildrenResources $false -ExtractOwnerName $false -UserId "MyUserId" -UserName "MyUserName" -ResourceKind "MyResourceKind" -GroupingCondition "GROUP_BY_ALERT_DEFINITION" -GroupId "MyGroupId" Invoke-VcfOpsDeleteCanceledAlerts -alertQuery $alertQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCanceledAlerts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertQuery = Initialize-VcfOpsAlertQuery Invoke-VcfOpsDeleteCanceledAlerts -alertQuery $alertQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCanceledAlerts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/bulk/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertquery</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-VcfOpsDisableAlertDefinitionInPolicies</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDisableAlertDefinitionInPolicies</command:noun> <maml:description> <maml:para>Disable alert definition in policies</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disable alert definition in policies</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDisableAlertDefinitionInPolicies</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Alert Definition 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Collection of policy identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Alert Definition 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Collection of policy identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDisableAlertDefinitionInPolicies -id "id_example" -policyId "MypolicyId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableAlertDefinitionInPolicies with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDisableAlertDefinitionInPolicies -id "id_example" -policyId "MypolicyId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableAlertDefinitionInPolicies with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertdefinitions/id/disable/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-VcfOpsEnableAlertDefinitionInPolicies</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsEnableAlertDefinitionInPolicies</command:noun> <maml:description> <maml:para>Enable alert definition in policies</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Enable alert definition in policies</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsEnableAlertDefinitionInPolicies</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Alert Definition 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Collection of policy identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Alert Definition 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Collection of policy identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsEnableAlertDefinitionInPolicies -id "id_example" -policyId "MypolicyId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableAlertDefinitionInPolicies with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsEnableAlertDefinitionInPolicies -id "id_example" -policyId "MypolicyId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableAlertDefinitionInPolicies with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertdefinitions/id/enable/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-VcfOpsGetAlert</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlert</command:noun> <maml:description> <maml:para>Look up an Alert by its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Example: <code>GET /api/alerts/{id}</code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlert</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>UUID of the alert</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>UUID of the alert</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>VMware.Bindings.Vcf.Ops.Model.Alert</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlert -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlert with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlert -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlert with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/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-VcfOpsGetAlertContributingSymptoms</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertContributingSymptoms</command:noun> <maml:description> <maml:para>Get the list of triggered symptoms for the requested alerts</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the list of triggered symptoms for the requested alerts<br/><b>NOTE:</b> This API only reports the symptoms that are defined on 'SELF'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertContributingSymptoms</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifiers of the Alerts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Identifiers of the Alerts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>VMware.Bindings.Vcf.Ops.Model.AlertContributingSymptoms</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertContributingSymptoms -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertContributingSymptoms with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertContributingSymptoms -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertContributingSymptoms with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/contributingsymptoms/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-VcfOpsGetAlertDefinitionById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertDefinitionById</command:noun> <maml:description> <maml:para>Get the Alert Definition using the identifier specified</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can look up details about a particular <i>alert definition</i></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertDefinitionById</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 Alert Definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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 Alert Definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinition</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertDefinitionById -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertDefinitionById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertDefinitionById -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertDefinitionById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertdefinitions/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-VcfOpsGetAlertDefinitions</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertDefinitions</command:noun> <maml:description> <maml:para>Get collection of Alert Definitions matching the search criteria specified</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the search criteria is not satisfied, the API will return all Alert Definitions</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertDefinitions</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The Adapter Kind key of the Alert Definitions to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>The Resource Kind key of the Alert Definitions to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier(s) of the Alert Definitions to search for.<br>Do not specify <i>adapterKind</i> or <i>resourceKind</i> if searching by the identifier</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The Adapter Kind key of the Alert Definitions to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>The Resource Kind key of the Alert Definitions to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier(s) of the Alert Definitions to search for.<br>Do not specify <i>adapterKind</i> or <i>resourceKind</i> if searching by the identifier</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinitions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertDefinitions -adapterKind "adapterKind_example" -resourceKind "resourceKind_example" -id "Myid" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertDefinitions with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertDefinitions </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertDefinitions with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertdefinitions/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-VcfOpsGetAlertNote</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertNote</command:noun> <maml:description> <maml:para>Get the requested Alert Note associated with an Alert</maml:para> </maml:description> </command:details> <maml:description> <maml:para><code> Example: GET /api/alerts/{id}/notes/{noteId} </code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertNote</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>UUID of the Alert</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>NoteId</maml:name> <maml:Description> <maml:para>Alert Note identifier</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>UUID of the Alert</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>NoteId</maml:name> <maml:Description> <maml:para>Alert Note identifier</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>VMware.Bindings.Vcf.Ops.Model.AlertNote</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertNote -id "id_example" -noteId "noteId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertNote with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertNote -id "id_example" -noteId "noteId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertNote with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/id/notes/noteId/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-VcfOpsGetAlertNotes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertNotes</command:noun> <maml:description> <maml:para>Get all the Alert Notes associated with an Alert</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Data includes a Collection of Alert Notes <br/><code> Example: GET /api/alerts/{id}/notes </code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertNotes</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>UUID of the Alert</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>UUID of the Alert</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertNotes</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertNotes -id "id_example" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertNotes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertNotes -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertNotes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/id/notes/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-VcfOpsGetAlertTypes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlertTypes</command:noun> <maml:description> <maml:para>Get all the Alert Types and Subtypes defined in the system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para><br/>Examples:<br/><br/><code>GET /api/alerts/types </code> returns the Problem Alerts specific Alert Types & Subtypes<br/><code>GET /api/alerts/types?ignoreLegacy=false </code> returns all the Alert Types & Subtypes<br/></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlertTypes</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IgnoreLegacy</maml:name> <maml:Description> <maml:para>Setting to true will filter out the legacy Alert Types & Subtypes Defaults to 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>true</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IgnoreLegacy</maml:name> <maml:Description> <maml:para>Setting to true will filter out the legacy Alert Types & Subtypes Defaults to 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>true</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertTypes</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlertTypes -ignoreLegacy $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertTypes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlertTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlertTypes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/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-VcfOpsGetAlerts</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAlerts</command:noun> <maml:description> <maml:para>Look up Alerts by their identifiers or using the identifiers of the Resources they are associated with</maml:para> </maml:description> </command:details> <maml:description> <maml:para><code> Example: GET /api/alerts?id={id1}&id={id2}&resourceId={resId1}&resourceId={resId2}</code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAlerts</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifiers of the Alerts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceId</maml:name> <maml:Description> <maml:para>Identifiers of the Resources whose Alerts you need to be looked up</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>Identifiers of the Alerts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceId</maml:name> <maml:Description> <maml:para>Identifiers of the Resources whose Alerts you need to be looked up</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Alerts</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAlerts -id "Myid" -resourceId "MyresourceId" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlerts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAlerts </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAlerts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/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-VcfOpsModifyAlerts</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsModifyAlerts</command:noun> <maml:description> <maml:para>Perform operations on one or more Alerts</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Modify multiple Alerts by looking them up using their identifiers and performing one of the following actions - <i>Suspend</i>, <i>Cancel</i>,<i>Take Ownership</i>, <i>Release Ownership</i><br/>Examples: <br/><code>POST /api/alerts?action=suspend&minutes=1</code> <br/><code>POST /api/alerts?action=cancel</code> <br/><code>POST /api/alerts?action=takeownership</code> <br/><code>POST /api/alerts?action=releaseownership</code> <br/><code>POST /api/alerts?action=assignownership</code> <br/><br/></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsModifyAlerts</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Action</maml:name> <maml:Description> <maml:para>The action to take</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>Identifiers of the Alerts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Minutes</maml:name> <maml:Description> <maml:para>The number of minutes to suspend an alert. Required when action is <b><i>Suspend</i></b>, otherwise ignored.</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>UserAccountID</maml:name> <maml:Description> <maml:para>User Account identifier. Optional request parameter that is applicable when action is <b><i>assignownership<b><i>.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Action</maml:name> <maml:Description> <maml:para>The action to take</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>Identifiers of the Alerts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Minutes</maml:name> <maml:Description> <maml:para>The number of minutes to suspend an alert. Required when action is <b><i>Suspend</i></b>, otherwise ignored.</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>UserAccountID</maml:name> <maml:Description> <maml:para>User Account identifier. Optional request parameter that is applicable when action is <b><i>assignownership<b><i>.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Alerts</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsModifyAlerts -action "action_example" -uuidValues $uuidValues -minutes 56 -userAccountID "userAccountID_example" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyAlerts with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsModifyAlerts -action "action_example" -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyAlerts with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuuidvalues</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-VcfOpsQueryAlert</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsQueryAlert</command:noun> <maml:description> <maml:para>Query for Alerts using one or more criteria specified in the Query Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Data returned includes a Collection of Alert Notes. <br/> <code> Example: POST /api/alerts/query </code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsQueryAlert</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertQuery</maml:name> <maml:Description> <maml:para>The alertQuery criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertQuery</maml:name> <maml:Description> <maml:para>The alertQuery criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Alerts</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $AlertQuery = Initialize-VcfOpsAlertQuery -CompositeOperator "AND" -AlertId "MyAlertId" -AlertName "MyAlertName" -ResourceQuery $ResourceQuery -ActiveOnly $false -AlertTypeSubtype $AlertTypeMapping -AlertCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN" -AlertStatus $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW" -AlertImpact "MyAlertImpact" -AlertDefinitionId "MyAlertDefinitionId" -AlertControlState $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN" -StartTimeRange $TimeRange -UpdateTimeRange $TimeRange -CancelTimeRange $TimeRange -IncludeChildrenResources $false -ExtractOwnerName $false -UserId "MyUserId" -UserName "MyUserName" -ResourceKind "MyResourceKind" -GroupingCondition "GROUP_BY_ALERT_DEFINITION" -GroupId "MyGroupId" Invoke-VcfOpsQueryAlert -alertQuery $alertQuery -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryAlert with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertQuery = Initialize-VcfOpsAlertQuery Invoke-VcfOpsQueryAlert -alertQuery $alertQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryAlert with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertquery</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-VcfOpsQueryAlertDefinitions</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsQueryAlertDefinitions</command:noun> <maml:description> <maml:para>Query collection of alert definitions matching the search criteria specified</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsQueryAlertDefinitions</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertDefinitionQuery</maml:name> <maml:Description> <maml:para>The alert definition query</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertDefinitionQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinitionQuery</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertDefinitionQuery</maml:name> <maml:Description> <maml:para>The alert definition query</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertDefinitionQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinitionQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinitions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AlertDefinitionQuery = Initialize-VcfOpsAlertDefinitionQuery -Ids "MyIds" -AdapterKinds "MyAdapterKinds" -ResourceKinds "MyResourceKinds" Invoke-VcfOpsQueryAlertDefinitions -page 0 -pageSize 1000 -alertDefinitionQuery $alertDefinitionQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryAlertDefinitions with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsQueryAlertDefinitions </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryAlertDefinitions with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertdefinitions/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertdefinitionquery</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-VcfOpsQueryAlertGroups</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsQueryAlertGroups</command:noun> <maml:description> <maml:para>Query for Alert groups using one or more criteria specified in the Query Spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para><code> Example: POST /api/alerts/group/{groupingCondition}/query </code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsQueryAlertGroups</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupingCondition</maml:name> <maml:Description> <maml:para>The condition to be used for grouping</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertQuery</maml:name> <maml:Description> <maml:para>The alertQuery criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>Adapter kind to be used for grouping alerts by SCOPE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>Resource kind to be used for grouping alerts by SCOPE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceNameFilter</maml:name> <maml:Description> <maml:para>Filter based on alert resource name (Used only in SCOPE flow)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupingCondition</maml:name> <maml:Description> <maml:para>The condition to be used for grouping</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertQuery</maml:name> <maml:Description> <maml:para>The alertQuery criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>Adapter kind to be used for grouping alerts by SCOPE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>Resource kind to be used for grouping alerts by SCOPE</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceNameFilter</maml:name> <maml:Description> <maml:para>Filter based on alert resource name (Used only in SCOPE flow)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertGroups</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $AlertQuery = Initialize-VcfOpsAlertQuery -CompositeOperator "AND" -AlertId "MyAlertId" -AlertName "MyAlertName" -ResourceQuery $ResourceQuery -ActiveOnly $false -AlertTypeSubtype $AlertTypeMapping -AlertCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN" -AlertStatus $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW" -AlertImpact "MyAlertImpact" -AlertDefinitionId "MyAlertDefinitionId" -AlertControlState $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN" -StartTimeRange $TimeRange -UpdateTimeRange $TimeRange -CancelTimeRange $TimeRange -IncludeChildrenResources $false -ExtractOwnerName $false -UserId "MyUserId" -UserName "MyUserName" -ResourceKind "MyResourceKind" -GroupingCondition "GROUP_BY_ALERT_DEFINITION" -GroupId "MyGroupId" Invoke-VcfOpsQueryAlertGroups -groupingCondition "GROUP_BY_ALERT_DEFINITION" -alertQuery $alertQuery -adapterKind "adapterKind_example" -resourceKind "resourceKind_example" -resourceNameFilter "resourceNameFilter_example" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryAlertGroups with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertQuery = Initialize-VcfOpsAlertQuery Invoke-VcfOpsQueryAlertGroups -groupingCondition "GROUP_BY_ALERT_DEFINITION" -alertQuery $alertQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryAlertGroups with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/group/groupingCondition/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertquery</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-VcfOpsQueryAlertNotes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsQueryAlertNotes</command:noun> <maml:description> <maml:para>Query for Alert Notes based on specified criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Data returned includes a Collection of Alert Notes</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsQueryAlertNotes</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertNotesQuery</maml:name> <maml:Description> <maml:para>The query spec used for looking up Alert Notes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertNotesQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertNotesQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertNotesQuery</maml:name> <maml:Description> <maml:para>The query spec used for looking up Alert Notes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertNotesQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertNotesQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertNotes</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $AlertQuery = Initialize-VcfOpsAlertQuery -CompositeOperator "AND" -AlertId "MyAlertId" -AlertName "MyAlertName" -ResourceQuery $ResourceQuery -ActiveOnly $false -AlertTypeSubtype $AlertTypeMapping -AlertCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN" -AlertStatus $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW" -AlertImpact "MyAlertImpact" -AlertDefinitionId "MyAlertDefinitionId" -AlertControlState $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN" -StartTimeRange $TimeRange -UpdateTimeRange $TimeRange -CancelTimeRange $TimeRange -IncludeChildrenResources $false -ExtractOwnerName $false -UserId "MyUserId" -UserName "MyUserName" -ResourceKind "MyResourceKind" -GroupingCondition "GROUP_BY_ALERT_DEFINITION" -GroupId "MyGroupId" "SYSTEM"$AlertNotesQuery = Initialize-VcfOpsAlertNotesQuery -CompositeOperator "AND" -AlertNoteId "MyAlertNoteId" -AlertQuery $AlertQuery -CreationTimeRange $TimeRange -UserName "MyUserName" -AlertNoteType $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $AlertQuery = Initialize-VcfOpsAlertQuery -CompositeOperator "AND" -AlertId "MyAlertId" -AlertName "MyAlertName" -ResourceQuery $ResourceQuery -ActiveOnly $false -AlertTypeSubtype $AlertTypeMapping -AlertCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN" -AlertStatus $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW" -AlertImpact "MyAlertImpact" -AlertDefinitionId "MyAlertDefinitionId" -AlertControlState $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN" -StartTimeRange $TimeRange -UpdateTimeRange $TimeRange -CancelTimeRange $TimeRange -IncludeChildrenResources $false -ExtractOwnerName $false -UserId "MyUserId" -UserName "MyUserName" -ResourceKind "MyResourceKind" -GroupingCondition "GROUP_BY_ALERT_DEFINITION" -GroupId "MyGroupId" "SYSTEM" -Content "MyContent" Invoke-VcfOpsQueryAlertNotes -alertNotesQuery $alertNotesQuery -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryAlertNotes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertQuery = Initialize-VcfOpsAlertQuery $AlertNotesQuery = Initialize-VcfOpsAlertNotesQuery -AlertQuery $AlertQuery Invoke-VcfOpsQueryAlertNotes -alertNotesQuery $alertNotesQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryAlertNotes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alerts/notes/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertnotesquery</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-VcfOpsUpdateAlertDefinition</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateAlertDefinition</command:noun> <maml:description> <maml:para>Update an existing Alert Definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an existing Alert Definition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateAlertDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertDefinition</maml:name> <maml:Description> <maml:para>The Alert Definition to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertDefinition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertDefinition</maml:name> <maml:Description> <maml:para>The Alert Definition to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertDefinition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinition</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet $AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" $AlertDefinitionState = Initialize-VcfOpsAlertDefinitionState -Severity "UNKNOWN" -BaseSymptomSet $OneOfSymptomSet -Impact $AlertDefinitionImpact -RecommendationPriorityMap @{ key_example = 0 } $AlertDefinition = Initialize-VcfOpsAlertDefinition -Id "MyId" -Name "MyName" -Description "MyDescription" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -WaitCycles 0 -CancelCycles 0 -Type 0 -SubType 0 -States $AlertDefinitionState -ForVCDTenants $false Invoke-VcfOpsUpdateAlertDefinition -alertDefinition $alertDefinition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateAlertDefinition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet $AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" $AlertDefinitionState = Initialize-VcfOpsAlertDefinitionState -Severity "UNKNOWN" -BaseSymptomSet $OneOfSymptomSet -Impact $AlertDefinitionImpact $AlertDefinition = Initialize-VcfOpsAlertDefinition -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -States $AlertDefinitionState Invoke-VcfOpsUpdateAlertDefinition -alertDefinition $alertDefinition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateAlertDefinition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/alertdefinitions/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertdefinition</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-VcfOpsActivateServices</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsActivateServices</command:noun> <maml:description> <maml:para>Save application service configuration on multiple resources.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Save application service configuration on multiple resources.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsActivateServices</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicationServiceList</maml:name> <maml:Description> <maml:para>Api supports one service configuration only</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ApplicationServiceList</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationServiceList</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicationServiceList</maml:name> <maml:Description> <maml:para>Api supports one service configuration only</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ApplicationServiceList</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationServiceList</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationTaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$KeyValue = Initialize-VcfOpsKeyValue -Key "MyKey" -Value "MyValue" $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -IsActivated $false -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServiceList = Initialize-VcfOpsApplicationServiceList -TargetIds "MyTargetIds" -Services $ServiceConfigurationsParameters Invoke-VcfOpsActivateServices -applicationServiceList $applicationServiceList </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsActivateServices with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$KeyValue = Initialize-VcfOpsKeyValue $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServiceList = Initialize-VcfOpsApplicationServiceList -TargetIds "MyTargetIds" -Services $ServiceConfigurationsParameters Invoke-VcfOpsActivateServices -applicationServiceList $applicationServiceList </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsActivateServices with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/services/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsapplicationservicelist</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-VcfOpsAddVcenterToConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddVcenterToConfiguration</command:noun> <maml:description> <maml:para>Add a vCenter to be monitored by the specified application monitoring configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add a vCenter for monitoring with specified application monitoring configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddVcenterToConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AppMonitoringUrl</maml:name> <maml:Description> <maml:para>Url of the application monitoring</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcUrl</maml:name> <maml:Description> <maml:para>The url of the vCenter to be monitored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>AppMonitoringUrl</maml:name> <maml:Description> <maml:para>Url of the application monitoring</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcUrl</maml:name> <maml:Description> <maml:para>The url of the vCenter to be monitored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsAddVcenterToConfiguration -appMonitoringUrl "appMonitoringUrl_example" -vcUrl "vcUrl_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddVcenterToConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsAddVcenterToConfiguration -appMonitoringUrl "appMonitoringUrl_example" -vcUrl "vcUrl_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddVcenterToConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/vcenter/add/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-VcfOpsCreateVCenterMapping</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateVCenterMapping</command:noun> <maml:description> <maml:para>Create vCenter mappings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create mappings between collector or collectorGroup and vCenters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateVCenterMapping</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterToCloudProxyList</maml:name> <maml:Description> <maml:para>vCenter Mapping object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyList</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyList</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterToCloudProxyList</maml:name> <maml:Description> <maml:para>vCenter Mapping object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyList</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyList</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyList</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VcenterToCloudProxy = Initialize-VcfOpsVcenterToCloudProxy -CollectorUUID "MyCollectorUUID" -CollectorGroupId "MyCollectorGroupId" -VCenterIds "MyVCenterIds" $VcenterToCloudProxyList = Initialize-VcfOpsVcenterToCloudProxyList -VCenterMappings $VcenterToCloudProxy Invoke-VcfOpsCreateVCenterMapping -vcenterToCloudProxyList $vcenterToCloudProxyList </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateVCenterMapping with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VcenterToCloudProxy = Initialize-VcfOpsVcenterToCloudProxy -VCenterIds "MyVCenterIds" $VcenterToCloudProxyList = Initialize-VcfOpsVcenterToCloudProxyList -VCenterMappings $VcenterToCloudProxy Invoke-VcfOpsCreateVCenterMapping -vcenterToCloudProxyList $vcenterToCloudProxyList </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateVCenterMapping with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/vccpmappings/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsvcentertocloudproxylist</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-VcfOpsDeleteVCenterMapping</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteVCenterMapping</command:noun> <maml:description> <maml:para>Delete vCenters mapping info</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete vCenters mapping info</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteVCenterMapping</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>vCenter IDs for unmapping</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>vCenter IDs for unmapping</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsDeleteVCenterMapping -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteVCenterMapping with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsDeleteVCenterMapping -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteVCenterMapping with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/vccpmappings/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuuidvalues</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-VcfOpsDownloadClientCertificate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDownloadClientCertificate</command:noun> <maml:description> <maml:para>Download Client Certificates</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Download Client Certificates</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDownloadClientCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorIpOrGroupName</maml:name> <maml:Description> <maml:para>Collector identifier to generate the certificates</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClientId</maml:name> <maml:Description> <maml:para>Client Identifier.This is combination of both VCID and VMMOR/UUID (VCID_VMMOR) of the VM</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>CollectorIpOrGroupName</maml:name> <maml:Description> <maml:para>Collector identifier to generate the certificates</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClientId</maml:name> <maml:Description> <maml:para>Client Identifier.This is combination of both VCID and VMMOR/UUID (VCID_VMMOR) of the VM</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml: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-VcfOpsDownloadClientCertificate -collectorIpOrGroupName "collectorIpOrGroupName_example" -clientId "clientId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownloadClientCertificate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDownloadClientCertificate -collectorIpOrGroupName "collectorIpOrGroupName_example" -clientId "clientId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownloadClientCertificate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/clientCertificate/collectorIpOrGroupName/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-VcfOpsGetAgentOperationStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAgentOperationStatus</command:noun> <maml:description> <maml:para>Get bootstrap action status by the given taskId</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The response contains information about the bootstrap action status by the given taskId.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAgentOperationStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Action identifier (result of the action: POST /api/actions/{id})</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Action identifier (result of the action: POST /api/actions/{id})</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.BootstrapStatus</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAgentOperationStatus -taskId "taskId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAgentOperationStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAgentOperationStatus -taskId "taskId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAgentOperationStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/taskId/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-VcfOpsGetApplicationResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetApplicationResources</command:noun> <maml:description> <maml:para>Get all available resources for application monitoring</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all available resources for application monitoring</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetApplicationResources</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetApplicationResources -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetApplicationResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetApplicationResources </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetApplicationResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/resources/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-VcfOpsGetConfigurationDetails</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetConfigurationDetails</command:noun> <maml:description> <maml:para>Get all the created application monitoring configurations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all the created application monitoring configurations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetConfigurationDetails</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AppMonitoringConfigurations</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetConfigurationDetails </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetConfigurationDetails with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetConfigurationDetails </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetConfigurationDetails with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/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-VcfOpsGetServiceConfigurationTemplate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetServiceConfigurationTemplate</command:noun> <maml:description> <maml:para>Get template of application configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Provides a template for the specified service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetServiceConfigurationTemplate</maml:name> <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 service</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>The name of the service</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ServiceConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetServiceConfigurationTemplate -name "name_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServiceConfigurationTemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetServiceConfigurationTemplate -name "name_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServiceConfigurationTemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/services/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-VcfOpsGetServiceConfigurations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetServiceConfigurations</command:noun> <maml:description> <maml:para>Get application service configuration by service name on the resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all configurations by service name on a specified resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetServiceConfigurations</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Resource identifier</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>Name</maml:name> <maml:Description> <maml:para>Name of the service</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Resource identifier</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>Name</maml:name> <maml:Description> <maml:para>Name of the service</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ServiceConfigurations</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetServiceConfigurations -id "id_example" -name "name_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServiceConfigurations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetServiceConfigurations -id "id_example" -name "name_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServiceConfigurations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/id/services/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-VcfOpsGetServiceOperationStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetServiceOperationStatus</command:noun> <maml:description> <maml:para>Get application configuration status by the given taskId</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The response contains information about the application action status by the given taskId.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetServiceOperationStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Action identifier (result of the action: POST /api/actions/{id})</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Action identifier (result of the action: POST /api/actions/{id})</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationConfigurationStatus</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetServiceOperationStatus -taskId "taskId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServiceOperationStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetServiceOperationStatus -taskId "taskId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServiceOperationStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/services/taskId/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-VcfOpsGetServicesConfigurations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetServicesConfigurations</command:noun> <maml:description> <maml:para>Get applications service configurations on the resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all services on a specified resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetServicesConfigurations</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Resource identifier</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>Resource identifier</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>VMware.Bindings.Vcf.Ops.Model.ApplicationServices</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetServicesConfigurations -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServicesConfigurations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetServicesConfigurations -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServicesConfigurations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/id/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>Invoke-VcfOpsInstallAgent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsInstallAgent</command:noun> <maml:description> <maml:para>Install agent on resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para><br>Install app monitoring agent on specified resource. <br>vCenters mapping should be present for this API to work. <br><br>Correct configuration for vCenters mapping - <br>vCenter is mapped to individual CP or CP part of non HA collector group. <br>vCenter is mapped to HA enabled collector group.<br><br>vCenters mapping APIs - <br>Create vCenters mappings API <code>POST /api/applications/vccpmappings</code>.<br>Delete vCenters mapping API <code>DELETE /api/applications/vccpmappings</code>.<br></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsInstallAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCredentials</maml:name> <maml:Description> <maml:para>Credentials of resources required to install the agent</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceCredentials</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceCredentials</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCredentials</maml:name> <maml:Description> <maml:para>Credentials of resources required to install the agent</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceCredentials</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceCredentials</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AgentTaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceCredential = Initialize-VcfOpsResourceCredential -ResourceId "MyResourceId" -Username "MyUsername" -Password "MyPassword" -AddRuntimeUser $false $ResourceCredentials = Initialize-VcfOpsResourceCredentials -_ResourceCredentials $ResourceCredential -RetainTelegrafConf $false Invoke-VcfOpsInstallAgent -resourceCredentials $resourceCredentials </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsInstallAgent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceCredential = Initialize-VcfOpsResourceCredential -ResourceId "MyResourceId" -Username "MyUsername" -Password "MyPassword" $ResourceCredentials = Initialize-VcfOpsResourceCredentials -_ResourceCredentials $ResourceCredential Invoke-VcfOpsInstallAgent -resourceCredentials $resourceCredentials </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsInstallAgent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcecredentials</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-VcfOpsQueryVCenterMappingsInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsQueryVCenterMappingsInfo</command:noun> <maml:description> <maml:para>Get vCenter mappings info</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get vCenter mappings based on the specified query</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsQueryVCenterMappingsInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterToCloudProxyQuery</maml:name> <maml:Description> <maml:para>vCenter Mapping Query object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterToCloudProxyQuery</maml:name> <maml:Description> <maml:para>vCenter Mapping Query object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxyList</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VcenterToCloudProxyQuery = Initialize-VcfOpsVcenterToCloudProxyQuery -CollectorUUIDs "MyCollectorUUIDs" -CollectorGroupIds "MyCollectorGroupIds" -VCenterIds "MyVCenterIds" Invoke-VcfOpsQueryVCenterMappingsInfo -vcenterToCloudProxyQuery $vcenterToCloudProxyQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryVCenterMappingsInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VcenterToCloudProxyQuery = Initialize-VcfOpsVcenterToCloudProxyQuery Invoke-VcfOpsQueryVCenterMappingsInfo -vcenterToCloudProxyQuery $vcenterToCloudProxyQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryVCenterMappingsInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/vccpmappings/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsvcentertocloudproxyquery</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-VcfOpsRemoveServicesConfigurations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsRemoveServicesConfigurations</command:noun> <maml:description> <maml:para>Remove application service configuration from the specified resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove application service configuration from the specified resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsRemoveServicesConfigurations</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Resource identifier</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>ServiceConfigurationDeleteParameters</maml:name> <maml:Description> <maml:para>Services need to be deleted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationDeleteParameters</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationDeleteParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>Resource identifier</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>ServiceConfigurationDeleteParameters</maml:name> <maml:Description> <maml:para>Services need to be deleted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationDeleteParameters</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationDeleteParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationTaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ServiceConfigurationDeleteParameter = Initialize-VcfOpsServiceConfigurationDeleteParameter -ServiceName "MyServiceName" -ConfigNames "MyConfigNames" $ServiceConfigurationDeleteParameters = Initialize-VcfOpsServiceConfigurationDeleteParameters -Services $ServiceConfigurationDeleteParameter Invoke-VcfOpsRemoveServicesConfigurations -id "id_example" -serviceConfigurationDeleteParameters $serviceConfigurationDeleteParameters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRemoveServicesConfigurations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ServiceConfigurationDeleteParameter = Initialize-VcfOpsServiceConfigurationDeleteParameter -ServiceName "MyServiceName" -ConfigNames "MyConfigNames" $ServiceConfigurationDeleteParameters = Initialize-VcfOpsServiceConfigurationDeleteParameters -Services $ServiceConfigurationDeleteParameter Invoke-VcfOpsRemoveServicesConfigurations -id "id_example" -serviceConfigurationDeleteParameters $serviceConfigurationDeleteParameters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRemoveServicesConfigurations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/id/services/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsserviceconfigurationdeleteparameters</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-VcfOpsRemoveVcenterFromConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsRemoveVcenterFromConfiguration</command:noun> <maml:description> <maml:para>Remove a vCenter from Application Monitoring Configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> Application Monitoring configuration will be deleted after removing last mapped vCenter from it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsRemoveVcenterFromConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AppMonitoringUrl</maml:name> <maml:Description> <maml:para>Url of the application monitoring</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcUrl</maml:name> <maml:Description> <maml:para>The url of the vCenter to be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>AppMonitoringUrl</maml:name> <maml:Description> <maml:para>Url of the application monitoring</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcUrl</maml:name> <maml:Description> <maml:para>The url of the vCenter to be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsRemoveVcenterFromConfiguration -appMonitoringUrl "appMonitoringUrl_example" -vcUrl "vcUrl_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRemoveVcenterFromConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsRemoveVcenterFromConfiguration -appMonitoringUrl "appMonitoringUrl_example" -vcUrl "vcUrl_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRemoveVcenterFromConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/vcenter/remove/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-VcfOpsSaveServicesConfigurations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSaveServicesConfigurations</command:noun> <maml:description> <maml:para>Save application service configuration on the specified resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Save application service configuration on the specified resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSaveServicesConfigurations</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Resource identifier</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>ApplicationServices</maml:name> <maml:Description> <maml:para>Services needed to save</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ApplicationServices</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationServices</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>Resource identifier</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>ApplicationServices</maml:name> <maml:Description> <maml:para>Services needed to save</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ApplicationServices</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationServices</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationTaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$KeyValue = Initialize-VcfOpsKeyValue -Key "MyKey" -Value "MyValue" $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -IsActivated $false -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServices = Initialize-VcfOpsApplicationServices -Services $ServiceConfigurationsParameters Invoke-VcfOpsSaveServicesConfigurations -id "id_example" -applicationServices $applicationServices </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSaveServicesConfigurations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$KeyValue = Initialize-VcfOpsKeyValue $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServices = Initialize-VcfOpsApplicationServices -Services $ServiceConfigurationsParameters Invoke-VcfOpsSaveServicesConfigurations -id "id_example" -applicationServices $applicationServices </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSaveServicesConfigurations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/id/services/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsapplicationservices</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-VcfOpsSignClientCertificate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSignClientCertificate</command:noun> <maml:description> <maml:para>Query to sign the Arc Client certificate</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Query to sign the Arc Client certificate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSignClientCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>Collector identifier to send the metrics for</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>RequestBody</maml:name> <maml:Description> <maml:para>Client certificate signing request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<byte[]></command:parameterValue> <dev:type> <maml:name>List<byte[]></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>Collector identifier to send the metrics for</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>RequestBody</maml:name> <maml:Description> <maml:para>Client certificate signing request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<byte[]></command:parameterValue> <dev:type> <maml:name>List<byte[]></maml: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-VcfOpsSignClientCertificate -collectorId 56 -requestBody 0 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSignClientCertificate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsSignClientCertificate -collectorId 56 -requestBody 0 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSignClientCertificate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/clientCertificate/collectorId/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-VcfOpsStartAgent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsStartAgent</command:noun> <maml:description> <maml:para>Start agent on the specified resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start agent on the specified resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsStartAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceParameters</maml:name> <maml:Description> <maml:para>IDs of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceParameters</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceParameters</maml:name> <maml:Description> <maml:para>IDs of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceParameters</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AgentTaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceParameters = Initialize-VcfOpsResourceParameters -ContextResourceIDs "MyContextResourceIDs" Invoke-VcfOpsStartAgent -resourceParameters $resourceParameters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStartAgent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceParameters = Initialize-VcfOpsResourceParameters -ContextResourceIDs "MyContextResourceIDs" Invoke-VcfOpsStartAgent -resourceParameters $resourceParameters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStartAgent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/start/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourceparameters</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-VcfOpsStopAgent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsStopAgent</command:noun> <maml:description> <maml:para>Stop agent on the specified resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stop agent on the specified resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsStopAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceParameters</maml:name> <maml:Description> <maml:para>IDs of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceParameters</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceParameters</maml:name> <maml:Description> <maml:para>IDs of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceParameters</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AgentTaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceParameters = Initialize-VcfOpsResourceParameters -ContextResourceIDs "MyContextResourceIDs" Invoke-VcfOpsStopAgent -resourceParameters $resourceParameters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStopAgent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceParameters = Initialize-VcfOpsResourceParameters -ContextResourceIDs "MyContextResourceIDs" Invoke-VcfOpsStopAgent -resourceParameters $resourceParameters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStopAgent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/stop/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourceparameters</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-VcfOpsSubscribe</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSubscribe</command:noun> <maml:description> <maml:para>Subscribe to Application Monitoring by downloading bootstrap bundle containing all required scripts for bootstraping ARC Agent from Endpoints</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Bootstrap Bundle primarily contains client certificates, Grains File containing configuration of<br>ARC Agent Components (ucp-minion, salt-minion, Telegraf) and seeder script.<br>This API also preseeds salt minion keys in ARC.<br>In SAAS, it also creates adapter if adapter does not exist.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSubscribe</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Ostype</maml:name> <maml:Description> <maml:para>The OS type, e.g. Windows, Unix</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmIp</maml:name> <maml:Description> <maml:para>The IP of Virtual Machine or UUID of Endpoint</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorIPOrGroupNm</maml:name> <maml:Description> <maml:para>IP of the Collector or Collector Group VirtualIP or Collector 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Ostype</maml:name> <maml:Description> <maml:para>The OS type, e.g. Windows, Unix</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmIp</maml:name> <maml:Description> <maml:para>The IP of Virtual Machine or UUID of Endpoint</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorIPOrGroupNm</maml:name> <maml:Description> <maml:para>IP of the Collector or Collector Group VirtualIP or Collector 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: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-VcfOpsSubscribe -ostype "ostype_example" -vmIp "vmIp_example" -collectorIPOrGroupNm "collectorIPOrGroupNm_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSubscribe with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsSubscribe -ostype "ostype_example" -vmIp "vmIp_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSubscribe with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/subscribe/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-VcfOpsUninstallAgent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUninstallAgent</command:noun> <maml:description> <maml:para>Uninstall agent from the resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uninstall app monitoring agent from the specified resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUninstallAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCredentials</maml:name> <maml:Description> <maml:para>Credentials of resources from which the agent must be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceCredentials</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceCredentials</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceCredentials</maml:name> <maml:Description> <maml:para>Credentials of resources from which the agent must be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceCredentials</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceCredentials</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AgentTaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceCredential = Initialize-VcfOpsResourceCredential -ResourceId "MyResourceId" -Username "MyUsername" -Password "MyPassword" -AddRuntimeUser $false $ResourceCredentials = Initialize-VcfOpsResourceCredentials -_ResourceCredentials $ResourceCredential -RetainTelegrafConf $false Invoke-VcfOpsUninstallAgent -resourceCredentials $resourceCredentials </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUninstallAgent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceCredential = Initialize-VcfOpsResourceCredential -ResourceId "MyResourceId" -Username "MyUsername" -Password "MyPassword" $ResourceCredentials = Initialize-VcfOpsResourceCredentials -_ResourceCredentials $ResourceCredential Invoke-VcfOpsUninstallAgent -resourceCredentials $resourceCredentials </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUninstallAgent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcecredentials</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-VcfOpsUnsubscribe</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUnsubscribe</command:noun> <maml:description> <maml:para>UnSubscribe to Application Monitoring by downloading bootstrap bundle containing all required scripts for Unbootstraping ARC Agent from Endpoints.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Bootstrap Bundle primarily contains client certificates, Grains File containing configuration of<br>ARC Agent Components (ucp-minion, salt-minion, Telegraf) and seeder script.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUnsubscribe</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmIp</maml:name> <maml:Description> <maml:para>The IP of 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>Ostype</maml:name> <maml:Description> <maml:para>The OS type, e.g. Windows, Unix</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Cleanup</maml:name> <maml:Description> <maml:para>Flag that indicates whether to clean all traces of application monitoring agent from vrops and ARC 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>CollectorIPOrGroupNm</maml:name> <maml:Description> <maml:para>IP of the Collector or Collector Group VirtualIP or Collector 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmIp</maml:name> <maml:Description> <maml:para>The IP of 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>Ostype</maml:name> <maml:Description> <maml:para>The OS type, e.g. Windows, Unix</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Cleanup</maml:name> <maml:Description> <maml:para>Flag that indicates whether to clean all traces of application monitoring agent from vrops and ARC 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>CollectorIPOrGroupNm</maml:name> <maml:Description> <maml:para>IP of the Collector or Collector Group VirtualIP or Collector 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: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-VcfOpsUnsubscribe -vmIp "vmIp_example" -ostype "ostype_example" -cleanup $true -collectorIPOrGroupNm "collectorIPOrGroupNm_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnsubscribe with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUnsubscribe -vmIp "vmIp_example" -ostype "ostype_example" -cleanup $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnsubscribe with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/unsubscribe/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-VcfOpsUpdateServicesConfigurations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateServicesConfigurations</command:noun> <maml:description> <maml:para>Update application service configuration on the specified resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update application service configuration on the specified resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateServicesConfigurations</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Resource identifier</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>ApplicationServices</maml:name> <maml:Description> <maml:para>Services needed to edit</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ApplicationServices</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationServices</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>Resource identifier</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>ApplicationServices</maml:name> <maml:Description> <maml:para>Services needed to edit</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ApplicationServices</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationServices</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ApplicationTaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$KeyValue = Initialize-VcfOpsKeyValue -Key "MyKey" -Value "MyValue" $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -IsActivated $false -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServices = Initialize-VcfOpsApplicationServices -Services $ServiceConfigurationsParameters Invoke-VcfOpsUpdateServicesConfigurations -id "id_example" -applicationServices $applicationServices </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateServicesConfigurations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$KeyValue = Initialize-VcfOpsKeyValue $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServices = Initialize-VcfOpsApplicationServices -Services $ServiceConfigurationsParameters Invoke-VcfOpsUpdateServicesConfigurations -id "id_example" -applicationServices $applicationServices </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateServicesConfigurations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/id/services/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsapplicationservices</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-VcfOpsUpgradeAgent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpgradeAgent</command:noun> <maml:description> <maml:para>Upgrade agent on the specified resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upgrade app monitoring agent on the specified resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpgradeAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceParameters</maml:name> <maml:Description> <maml:para>IDs of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceParameters</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceParameters</maml:name> <maml:Description> <maml:para>IDs of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceParameters</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AgentTaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceParameters = Initialize-VcfOpsResourceParameters -ContextResourceIDs "MyContextResourceIDs" Invoke-VcfOpsUpgradeAgent -resourceParameters $resourceParameters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpgradeAgent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceParameters = Initialize-VcfOpsResourceParameters -ContextResourceIDs "MyContextResourceIDs" Invoke-VcfOpsUpgradeAgent -resourceParameters $resourceParameters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpgradeAgent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/applications/agents/upgrade/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourceparameters</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-VcfOpsGetSystemAudit</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetSystemAudit</command:noun> <maml:description> <maml:para>Get system audit report</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get system audit report</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetSystemAudit</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SystemAuditReports</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetSystemAudit </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSystemAudit with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetSystemAudit </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSystemAudit with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/audit/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-VcfOpsAcquireToken</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAcquireToken</command:noun> <maml:description> <maml:para>Acquire a token to perform REST API calls</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Performing a <code>POST /api/auth/token/acquire</code> would yield a response object that includes token and its validity.<br/>HTTP Status 401 will be sent back if the authentication operation has failed.<br/><b>NOTE:</b> The validity of the acquired token is extended after each call and is set to 6 hours from the last call.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAcquireToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UsernamePassword</maml:name> <maml:Description> <maml:para>The UsernamePassword object that encapsulates username, password and optionally the name of an Auth Source as specified by the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UsernamePassword</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UsernamePassword</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UsernamePassword</maml:name> <maml:Description> <maml:para>The UsernamePassword object that encapsulates username, password and optionally the name of an Auth Source as specified by the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UsernamePassword</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UsernamePassword</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthToken</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UsernamePassword = Initialize-VcfOpsUsernamePassword -Username "MyUsername" -AuthSource "MyAuthSource" -Password "MyPassword" Invoke-VcfOpsAcquireToken -usernamePassword $usernamePassword </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAcquireToken with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UsernamePassword = Initialize-VcfOpsUsernamePassword -Username "MyUsername" -Password "MyPassword" Invoke-VcfOpsAcquireToken -usernamePassword $usernamePassword </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAcquireToken with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/token/acquire/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsusernamepassword</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-VcfOpsAddAuthSource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddAuthSource</command:noun> <maml:description> <maml:para>Add a new authentication source in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the authentication source is of type LDAP or AD and if ssl is enabled, the response object will contain a list of certificates found matching with the provided host.If the authentication source is not of type LDAP or AD (or) if ssl is not enabled, then the authentication source is available for use as soon as the api call is successful.It is the duty of the caller to call the PATCH (/sources) api with the certificate details. Once the PATCH api call is successful, the authentication source is available for use.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddAuthSource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>Contains authSource's type and its properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>Contains authSource's type and its properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Description "MyDescription" -Required $false -Modifiable $false $Properties = Initialize-VcfOpsProperties -Property $AuthSourceProperty $AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" -Description "MyDescription" -Links $Link -Properties $Properties $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AuthSource = Initialize-VcfOpsAuthSource -Id "MyId" -Name "MyName" -SourceType $AuthSourcetype -Created 0 -LastModified 0 -Links $Link -Property $NameValue -Certificates $Certificate Invoke-VcfOpsAddAuthSource -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddAuthSource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate $AuthSource = Initialize-VcfOpsAuthSource -Name "MyName" -SourceType $AuthSourcetype -Property $NameValue -Certificates $Certificate Invoke-VcfOpsAddAuthSource -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddAuthSource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsauthsource</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-VcfOpsAddRolePrivileges</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddRolePrivileges</command:noun> <maml:description> <maml:para>Add the privileges to a user role</maml:para> </maml:description> </command:details> <maml:description> <maml:para>New privileges union with any previous privileges.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddRolePrivileges</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrivilegeKeys</maml:name> <maml:Description> <maml:para>The list of privileges to be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrivilegeKeys</maml:name> <maml:Description> <maml:para>The list of privileges to be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PrivilegeKeys = Initialize-VcfOpsPrivilegeKeys -PrivilegeKey "MyPrivilegeKey" Invoke-VcfOpsAddRolePrivileges -roleName "roleName_example" -privilegeKeys $privilegeKeys </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddRolePrivileges with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PrivilegeKeys = Initialize-VcfOpsPrivilegeKeys -PrivilegeKey "MyPrivilegeKey" Invoke-VcfOpsAddRolePrivileges -roleName "roleName_example" -privilegeKeys $privilegeKeys </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddRolePrivileges with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/roles/roleName/privileges/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsprivilegekeys</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-VcfOpsAssignRolePermissionToUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAssignRolePermissionToUser</command:noun> <maml:description> <maml:para>Assign a role permission to a particular user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Replaces the existing role permission entirety if it exists already for the named role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAssignRolePermissionToUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>Identifier of the user to which the role permission needs to be assigned</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>RolePermission</maml:name> <maml:Description> <maml:para>The role permission to assign</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.RolePermission</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RolePermission</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>Identifier of the user to which the role permission needs to be assigned</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>RolePermission</maml:name> <maml:Description> <maml:para>The role permission to assign</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.RolePermission</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RolePermission</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RolePermissions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link Invoke-VcfOpsAssignRolePermissionToUser -userId "userId_example" -rolePermission $rolePermission </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignRolePermissionToUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" Invoke-VcfOpsAssignRolePermissionToUser -userId "userId_example" -rolePermission $rolePermission </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignRolePermissionToUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/users/userId/permissions/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsrolepermission</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-VcfOpsAssignRolePermissionToUserGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAssignRolePermissionToUserGroup</command:noun> <maml:description> <maml:para>Assign a role permission to a particular user group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Replaces existing role permission entirety if it exists already for the named role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAssignRolePermissionToUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Identifier of the user group</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>RolePermission</maml:name> <maml:Description> <maml:para>The role permission to assign.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.RolePermission</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RolePermission</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Identifier of the user group</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>RolePermission</maml:name> <maml:Description> <maml:para>The role permission to assign.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.RolePermission</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RolePermission</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RolePermissions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link Invoke-VcfOpsAssignRolePermissionToUserGroup -groupId "groupId_example" -rolePermission $rolePermission </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignRolePermissionToUserGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" Invoke-VcfOpsAssignRolePermissionToUserGroup -groupId "groupId_example" -rolePermission $rolePermission </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignRolePermissionToUserGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/groupId/permissions/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsrolepermission</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-VcfOpsAssignTraversalSpecToUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAssignTraversalSpecToUser</command:noun> <maml:description> <maml:para>(Deprecated) Assign a traversal specification to a particular user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Traversal specifications assigned through this API will add the specified traversal specification to a role permission for the ReadOnly role. It will also update the user's existing role permissions with this traversal specification.<br/>This API is replaced by the <code>assignRolePermissionToUser</code> and <code>unassignRolePermissionFromUser</code> APIs which are PUT and DELETE operations respectively at the <code>/auth/usergroups/{groupId}/permissions</code> endpoint.<strong>Note:</strong> mixing current and deprecated APIs is not recommended and may result in undefined behavior.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAssignTraversalSpecToUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>Identifier of the user to which the traversal spec needs to be assigned</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>TraversalSpecInstance</maml:name> <maml:Description> <maml:para>The traversal specification to assign to the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>Identifier of the user to which the traversal spec needs to be assigned</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>TraversalSpecInstance</maml:name> <maml:Description> <maml:para>The traversal specification to assign to the user</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" Invoke-VcfOpsAssignTraversalSpecToUser -userId "userId_example" -traversalSpecInstance $traversalSpecInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignTraversalSpecToUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -Name "MyName" Invoke-VcfOpsAssignTraversalSpecToUser -userId "userId_example" -traversalSpecInstance $traversalSpecInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignTraversalSpecToUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/users/userId/traversalspecs/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstraversalspecinstance</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-VcfOpsAssignTraversalSpecToUserGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAssignTraversalSpecToUserGroup</command:noun> <maml:description> <maml:para>(Deprecated) Assign a traversal specification to a particular user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Traversal specifications assigned through this API will add the specified traversal specification to a role permission for the ReadOnly role. It will also update the user's existing role permissions with this traversal specification.<br/>This API is replaced by the <code>assignRolePermissionToUser</code> and <code>unassignRolePermissionFromUser</code> APIs which are PUT and DELETE operations respectively at the <code>/auth/usergroups/{groupId}/permissions</code> endpoint.<strong>Note:</strong> mixing current and deprecated APIs is not recommended and may result in undefined behavior.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAssignTraversalSpecToUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Identifier of the user group to which the traversal spec needs to be assigned</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>TraversalSpecInstance</maml:name> <maml:Description> <maml:para>The traversal specification to assign to the user group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Identifier of the user group to which the traversal spec needs to be assigned</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>TraversalSpecInstance</maml:name> <maml:Description> <maml:para>The traversal specification to assign to the user group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" Invoke-VcfOpsAssignTraversalSpecToUserGroup -groupId "groupId_example" -traversalSpecInstance $traversalSpecInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignTraversalSpecToUserGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -Name "MyName" Invoke-VcfOpsAssignTraversalSpecToUserGroup -groupId "groupId_example" -traversalSpecInstance $traversalSpecInstance </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignTraversalSpecToUserGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/groupId/traversalspecs/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstraversalspecinstance</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-VcfOpsChangePassword</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsChangePassword</command:noun> <maml:description> <maml:para>Change the password of the active user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Change the password of the active user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsChangePassword</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PasswordChange</maml:name> <maml:Description> <maml:para>PasswordChange object that encapsulates current and new passwords</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PasswordChange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PasswordChange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PasswordChange</maml:name> <maml:Description> <maml:para>PasswordChange object that encapsulates current and new passwords</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PasswordChange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PasswordChange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PasswordChange = Initialize-VcfOpsPasswordChange -CurrentPassword "MyCurrentPassword" -NewPassword "MyNewPassword" Invoke-VcfOpsChangePassword -passwordChange $passwordChange </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsChangePassword with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PasswordChange = Initialize-VcfOpsPasswordChange -CurrentPassword "MyCurrentPassword" -NewPassword "MyNewPassword" Invoke-VcfOpsChangePassword -passwordChange $passwordChange </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsChangePassword with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/users/passwordchange/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspasswordchange</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-VcfOpsCreateScope</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateScope</command:noun> <maml:description> <maml:para>Create a new Scope</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new Scope.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateScope</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Scope Details to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Scope</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Scope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Scope Details to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Scope</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Scope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Scope</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Scope = Initialize-VcfOpsScope -Id "MyId" -Name "MyName" -Description "MyDescription" -TraversalSpecInstances $TraversalSpecInstance Invoke-VcfOpsCreateScope -scope $scope </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateScope with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Scope = Initialize-VcfOpsScope -Name "MyName" Invoke-VcfOpsCreateScope -scope $scope </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateScope with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/scopes/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsscope</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-VcfOpsCreateUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateUser</command:noun> <maml:description> <maml:para>Create a new user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The user object for creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.User</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>The user object for creation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.User</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>VMware.Bindings.Vcf.Ops.Model.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link $User = Initialize-VcfOpsUser -Id "MyId" -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Password "MyPassword" -EmailAddress "MyEmailAddress" -DistinguishedName "MyDistinguishedName" -Enabled $false -GroupIds "MyGroupIds" -RoleNames "MyRoleNames" -RolePermissions $RolePermission -LastLoginTime 0 -ExternalId "MyExternalId" -Links $Link Invoke-VcfOpsCreateUser -user $user </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$User = Initialize-VcfOpsUser -Username "MyUsername" -Password "MyPassword" Invoke-VcfOpsCreateUser -user $user </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/users/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuser</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-VcfOpsCreateUserGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateUserGroup</command:noun> <maml:description> <maml:para>Create a new local user group or import SSO/VIDM/LDAP/AD/VIDB user groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the authSourceId is specified(in the request), then the user group will be imported from the corresponding auth source (LDAP/AD/SSO/VIDM/VIDB).Note that the id of the user group has to be null. <br/>For LDAP/AD groups the distinguishedName should be provided in the name field. <br/>The value of displayName is used only while importing LDAP/AD groups, and if it is not provided then the value of name will be assigned to it. For SSO/VIDM groups the value of name is assigned to displayName. <br/><b>NOTE:</b> Before importing please make sure that the group exists in the specified authSource by using the following API - <i> /api/auth/sources/{id}/usergroups/search </i>. Otherwise, if you try to import a non-existing group, a new one will be created with the specified authSourceId.<br/><b>NOTE:</b> In the case of vIDB user group, the import occurs based on the provided externalId. If other provided details are incorrect, they will be asynchronously updated with the correct values right after the import operation is completed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserGroup</maml:name> <maml:Description> <maml:para>The group object to be created.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserGroup</maml:name> <maml:Description> <maml:para>The group object to be created.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link $UserGroup = Initialize-VcfOpsUserGroup -Id "MyId" -AuthSourceId "MyAuthSourceId" -Name "MyName" -Description "MyDescription" -DisplayName "MyDisplayName" -UserIds "MyUserIds" -RoleNames "MyRoleNames" -RolePermissions $RolePermission -ExternalId "MyExternalId" -Links $Link Invoke-VcfOpsCreateUserGroup -userGroup $userGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateUserGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UserGroup = Initialize-VcfOpsUserGroup -Name "MyName" Invoke-VcfOpsCreateUserGroup -userGroup $userGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateUserGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsusergroup</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-VcfOpsCreateUserRole</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateUserRole</command:noun> <maml:description> <maml:para>Create a user role</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a user role</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateUserRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserRole</maml:name> <maml:Description> <maml:para>The UserRole object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserRole</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserRole</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserRole</maml:name> <maml:Description> <maml:para>The UserRole object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserRole</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserRole</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserRole</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $UserRole = Initialize-VcfOpsUserRole -Name "MyName" -Description "MyDescription" -DisplayName "MyDisplayName" -PrivilegeKeys "MyPrivilegeKeys" -SystemCreated $false -Links $Link Invoke-VcfOpsCreateUserRole -userRole $userRole </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateUserRole with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UserRole = Initialize-VcfOpsUserRole -Name "MyName" Invoke-VcfOpsCreateUserRole -userRole $userRole </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateUserRole with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/roles/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuserrole</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-VcfOpsDeleteAuthSource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteAuthSource</command:noun> <maml:description> <maml:para>Delete an authentication source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>During the deletion of the SSO SAML/VCF SSO auth source, the same 'username' and 'password' which has been used while the creating this sso auth source, should be sent to the payload object.<br/><b>Note:</b> Force flag is applicable only for VCF SSO auth source. If force is true, VMware Cloud Foundation Operations continues to attempt to delete the VCF SSO auth source even when errors occur.<br/>If you set it to false, VMware Cloud Foundation Operations stops attempting to removethe auth source if VCF SSO server fails</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteAuthSource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para>Id of the auth source</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>Force</maml:name> <maml:Description> <maml:para>This flag is applicable only to VCF SSO authentication sources.</maml:para> </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>NameValues</maml:name> <maml:Description> <maml:para>List of properties required for deletion of the auth source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NameValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NameValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para>Id of the auth source</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>Force</maml:name> <maml:Description> <maml:para>This flag is applicable only to VCF SSO authentication sources.</maml:para> </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>NameValues</maml:name> <maml:Description> <maml:para>List of properties required for deletion of the auth source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NameValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NameValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $NameValues = Initialize-VcfOpsNameValues -NameValuePairs $NameValue Invoke-VcfOpsDeleteAuthSource -sourceId "sourceId_example" -force $false -nameValues $nameValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAuthSource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteAuthSource -sourceId "sourceId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteAuthSource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/sourceId/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsnamevalues</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-VcfOpsDeleteScopes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteScopes</command:noun> <maml:description> <maml:para>Delete scopes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete scopes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteScopes</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>Scope ids to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>Scope ids to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsDeleteScopes -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteScopes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsDeleteScopes -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteScopes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/scopes/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuuidvalues</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-VcfOpsDeleteUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteUser</command:noun> <maml:description> <maml:para>Delete a user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the user being deleted is an SSO/LDAP/AD user, the user gets deleted(removed) from VMware Cloud Foundation Operations ONLY and does not get actually deleted.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the local user</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>The identifier of the local user</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteUser -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteUser -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/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-VcfOpsDeleteUserGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteUserGroup</command:noun> <maml:description> <maml:para>Delete a local user group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a local user group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the user group</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>The identifier of the user group</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteUserGroup -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUserGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteUserGroup -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUserGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/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-VcfOpsDeleteUserGroups</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteUserGroups</command:noun> <maml:description> <maml:para>Delete a list of user groups using their identifiers</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a list of user groups using their identifiers</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteUserGroups</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifiers of the local user group objects</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>The identifiers of the local user group objects</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteUserGroups -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUserGroups with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteUserGroups -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUserGroups with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/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-VcfOpsDeleteUserRole</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteUserRole</command:noun> <maml:description> <maml:para>Remove role with given role name</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove role with given role name</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteUserRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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>RoleName</maml:name> <maml:Description> <maml:para>The name 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>Invoke-VcfOpsDeleteUserRole -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUserRole with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteUserRole -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUserRole with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/roles/roleName/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-VcfOpsDeleteUsers</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteUsers</command:noun> <maml:description> <maml:para>Delete a collection of users with the given identifiers</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the user which is being deleted is an SSO/LDAP/AD user, then it gets deleted(removed) from VMware Cloud Foundation Operations ONLY and does not get actually deleted.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteUsers</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifiers of all users that need to be deleted from the system</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>The identifiers of all users that need to be deleted from the system</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteUsers -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUsers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteUsers -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteUsers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/users/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-VcfOpsGetAllObjectScopes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAllObjectScopes</command:noun> <maml:description> <maml:para>Get all scopes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all scopes available in the environment</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAllObjectScopes</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ScopesDetails</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAllObjectScopes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAllObjectScopes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAllObjectScopes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAllObjectScopes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/scopes/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-VcfOpsGetAssignedRolePermissionsForCurrentUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAssignedRolePermissionsForCurrentUser</command:noun> <maml:description> <maml:para>Get assigned role permissions for an initiator of this API method</maml:para> </maml:description> </command:details> <maml:description> <maml:para><br><br><b>Note:</b>&nbsp;The provided hrefs are functional for the users with 'administration.accesscontrol.viewpage' (View Access Control Page) privilege.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAssignedRolePermissionsForCurrentUser</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RolePermissions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAssignedRolePermissionsForCurrentUser </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAssignedRolePermissionsForCurrentUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAssignedRolePermissionsForCurrentUser </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAssignedRolePermissionsForCurrentUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/currentuser/permissions/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-VcfOpsGetAssignedRolePermissionsForUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAssignedRolePermissionsForUser</command:noun> <maml:description> <maml:para>Get assigned role permissions for a user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get assigned role permissions for a specified user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAssignedRolePermissionsForUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>The Identifier of the user to which the role permission needs to be assigned</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>UserId</maml:name> <maml:Description> <maml:para>The Identifier of the user to which the role permission needs to be assigned</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>VMware.Bindings.Vcf.Ops.Model.RolePermissions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAssignedRolePermissionsForUser -userId "userId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAssignedRolePermissionsForUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAssignedRolePermissionsForUser -userId "userId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAssignedRolePermissionsForUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/users/userId/permissions/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-VcfOpsGetAssignedRolePermissionsForUserGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAssignedRolePermissionsForUserGroup</command:noun> <maml:description> <maml:para>Get assigned role permissions for the user group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get assigned role permissions for the specified user group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAssignedRolePermissionsForUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Identifier of the user group which role permissions need to be retrieved</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>GroupId</maml:name> <maml:Description> <maml:para>Identifier of the user group which role permissions need to be retrieved</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>VMware.Bindings.Vcf.Ops.Model.RolePermissions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAssignedRolePermissionsForUserGroup -groupId "groupId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAssignedRolePermissionsForUserGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAssignedRolePermissionsForUserGroup -groupId "groupId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAssignedRolePermissionsForUserGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/groupId/permissions/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-VcfOpsGetAuthSource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAuthSource</command:noun> <maml:description> <maml:para>Retrieve detailed information about a particular authentication source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The auth source can be SSO/LDAP/AD. <br/>For the <i>LDAP/AD</i> auth source, the request should contain the name of the user.<br/>For the <i>SSO</i> auth source, request should contain the name of the user and the sso domain.<br/>User-group's username can contain wildcards. Maximum of 25 user-groups are returned for SSO auth source. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAuthSource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para>Id of the auth source</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>SourceId</maml:name> <maml:Description> <maml:para>Id of the auth source</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>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAuthSource -sourceId "sourceId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAuthSource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAuthSource -sourceId "sourceId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAuthSource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/sourceId/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-VcfOpsGetAuthSourceType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAuthSourceType</command:noun> <maml:description> <maml:para>Retrieve information about a particular authentication source type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve information about a particular authentication source type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAuthSourceType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para>The ID of the source 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>SourceId</maml:name> <maml:Description> <maml:para>The ID of the source 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>VMware.Bindings.Vcf.Ops.Model.AuthSourcetype</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAuthSourceType -sourceId "sourceId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAuthSourceType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAuthSourceType -sourceId "sourceId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAuthSourceType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sourcetypes/sourceId/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-VcfOpsGetAuthSourceTypes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAuthSourceTypes</command:noun> <maml:description> <maml:para>Get all the available authentication source types</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all the available authentication source types</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAuthSourceTypes</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSourcetypes</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAuthSourceTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAuthSourceTypes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAuthSourceTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAuthSourceTypes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sourcetypes/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-VcfOpsGetAuthSources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAuthSources</command:noun> <maml:description> <maml:para>Get all the available authentication sources in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all the available authentication sources in the system.<br/><b>NOTE:</b> This API works both for authenticated and un-authenticated access. In case of authenticated access (by providing the Authorization header) it will return more information including auth source properties. Please also note that while triggering the API through Swagger interface it will work in un-authenticated scenario (Swagger will not send the Authorization header).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAuthSources</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAuthSources </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAuthSources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAuthSources </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAuthSources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/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-VcfOpsGetAvailablePrivilegeGroups</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAvailablePrivilegeGroups</command:noun> <maml:description> <maml:para>Get the available privilege groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no privilege key is set, all available Privilege Groups will be granted</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAvailablePrivilegeGroups</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The keys of the privilege groups to get, null or empty to return all</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>Key</maml:name> <maml:Description> <maml:para>The keys of the privilege groups to get, null or empty to return all</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>VMware.Bindings.Vcf.Ops.Model.PrivilegeGroups</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAvailablePrivilegeGroups -key "Mykey" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAvailablePrivilegeGroups with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAvailablePrivilegeGroups </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAvailablePrivilegeGroups with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/privilegegroups/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-VcfOpsGetAvailablePrivileges</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAvailablePrivileges</command:noun> <maml:description> <maml:para>Get the available privileges</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no privilege key is set, all available Privileges will be granted</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAvailablePrivileges</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The keys of the privileges to get, null or empty to return all</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>Key</maml:name> <maml:Description> <maml:para>The keys of the privileges to get, null or empty to return all</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>VMware.Bindings.Vcf.Ops.Model.Privileges</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAvailablePrivileges -key "Mykey" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAvailablePrivileges with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAvailablePrivileges </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAvailablePrivileges with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/privileges/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-VcfOpsGetCurrentUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCurrentUser</command:noun> <maml:description> <maml:para>Look up for an initiator of this API method</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, one can look up the details of a user initiated this API method.<br/><br><br><b>Note:</b>&nbsp;The provided hrefs are functional for the users with 'administration.accesscontrol.viewpage' (View Access Control Page) privilege.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCurrentUser</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCurrentUser </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCurrentUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCurrentUser </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCurrentUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/currentuser/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-VcfOpsGetCurrentUserRolePrivileges</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCurrentUserRolePrivileges</command:noun> <maml:description> <maml:para>Get privileges of a role for an initiator of this API method</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>Note:</b>The provided hrefs are functional for the users with 'administration.accesscontrol.viewpage' (View Access Control Page) privilege.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCurrentUserRolePrivileges</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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>RoleName</maml:name> <maml:Description> <maml:para>The name 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>VMware.Bindings.Vcf.Ops.Model.Privileges</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCurrentUserRolePrivileges -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCurrentUserRolePrivileges with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCurrentUserRolePrivileges -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCurrentUserRolePrivileges with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/currentuser/roles/roleName/privileges/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-VcfOpsGetRoleByName</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetRoleByName</command:noun> <maml:description> <maml:para>Look up a role with the given name</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Look up a role with the given name</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetRoleByName</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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>RoleName</maml:name> <maml:Description> <maml:para>The name 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>VMware.Bindings.Vcf.Ops.Model.UserRole</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetRoleByName -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRoleByName with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetRoleByName -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRoleByName with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/roles/roleName/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-VcfOpsGetRolePrivileges</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetRolePrivileges</command:noun> <maml:description> <maml:para>Get the privileges for a user role</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the privileges for a user role</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetRolePrivileges</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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>RoleName</maml:name> <maml:Description> <maml:para>The name 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>VMware.Bindings.Vcf.Ops.Model.Privileges</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetRolePrivileges -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRolePrivileges with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetRolePrivileges -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRolePrivileges with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/roles/roleName/privileges/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-VcfOpsGetRoles</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetRoles</command:noun> <maml:description> <maml:para>Find list of application roles using the role names</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Find list of application roles using the role names</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetRoles</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>List of valid role 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>RoleName</maml:name> <maml:Description> <maml:para>List of valid role 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>VMware.Bindings.Vcf.Ops.Model.UserRoles</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetRoles -roleName "MyroleName" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRoles with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetRoles </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRoles with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/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-VcfOpsGetScope</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetScope</command:noun> <maml:description> <maml:para>Get the scope</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the scope by its id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetScope</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ScopeId</maml:name> <maml:Description> <maml:para>The scope id to retrieve</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>ScopeId</maml:name> <maml:Description> <maml:para>The scope id to retrieve</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>VMware.Bindings.Vcf.Ops.Model.ScopeDetails</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetScope -scopeId "scopeId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetScope with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetScope -scopeId "scopeId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetScope with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/scopes/scopeId/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-VcfOpsGetTraversalSpecs</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetTraversalSpecs</command:noun> <maml:description> <maml:para>Get/Query the list of all traversal specification templates in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no optional parameters passed, the API will return all traversal specification templates in the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetTraversalSpecs</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind of the traversal specification template</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>Name</maml:name> <maml:Description> <maml:para>The name of the traversal specification template</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>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind of the traversal specification template</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>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind of the traversal specification template</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>Name</maml:name> <maml:Description> <maml:para>The name of the traversal specification template</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>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind of the traversal specification template</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>VMware.Bindings.Vcf.Ops.Model.TraversalSpecs</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetTraversalSpecs -adapterKind "MyadapterKind" -name "Myname" -resourceKind "MyresourceKind" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTraversalSpecs with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetTraversalSpecs </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTraversalSpecs with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/traversalspecs/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-VcfOpsGetUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetUser</command:noun> <maml:description> <maml:para>Look up a particular user using its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can look up details about a particular <i>local user</i></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetUser</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 user</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>The ID of the user</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>VMware.Bindings.Vcf.Ops.Model.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetUser -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetUser -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/users/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-VcfOpsGetUserGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetUserGroup</command:noun> <maml:description> <maml:para>Look up a local user group using its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Look up a local user group using its identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the user group</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>The identifier of the user group</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>VMware.Bindings.Vcf.Ops.Model.UserGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetUserGroup -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetUserGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetUserGroup -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetUserGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/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-VcfOpsGetUserGroups</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetUserGroups</command:noun> <maml:description> <maml:para>Retrieve a list of local user groups using identifiers or/and names</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If none of the parameters are specified, all the user groups in the system are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetUserGroups</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifiers of the local user groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Name</maml:name> <maml:Description> <maml:para>The names of the local user groups</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 identifiers of the local user groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Name</maml:name> <maml:Description> <maml:para>The names of the local user groups</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>VMware.Bindings.Vcf.Ops.Model.UserGroups</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetUserGroups -id "Myid" -name "Myname" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetUserGroups with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetUserGroups </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetUserGroups with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/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-VcfOpsGetUsers</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetUsers</command:noun> <maml:description> <maml:para>Look up a list of users using the user identifiers or their role names</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If both ids and roleNames are not specified, information about all the <i>local users</i> are being returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetUsers</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>A list of identifiers in UUID format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RoleName</maml:name> <maml:Description> <maml:para>A list of valid role 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>A list of usernames that is used for partial and complete matching</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>A list of identifiers in UUID format</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RoleName</maml:name> <maml:Description> <maml:para>A list of valid role 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>A list of usernames that is used for partial and complete matching</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>VMware.Bindings.Vcf.Ops.Model.UserList</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetUsers -id "Myid" -roleName "MyroleName" -username "Myusername" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetUsers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetUsers </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetUsers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/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-VcfOpsImportUsers</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsImportUsers</command:noun> <maml:description> <maml:para>Import users from the auth source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Auth source can be SSO/VIDM/LDAP/AD/VIDB. <br/>When a user is being re-imported, make sure to populate the \"id\" field of the user.<br/><b>NOTE:</b> In the case of vIDB users, the import occurs based on the provided externalId. If other provided details are incorrect, they will be asynchronously updated with the correct values right after the import operation is completed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsImportUsers</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 Auth source</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>UserList</maml:name> <maml:Description> <maml:para>The List of users to be imported</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserList</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserList</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 Auth source</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>UserList</maml:name> <maml:Description> <maml:para>The List of users to be imported</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserList</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserList</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserList</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link $User = Initialize-VcfOpsUser -Id "MyId" -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Password "MyPassword" -EmailAddress "MyEmailAddress" -DistinguishedName "MyDistinguishedName" -Enabled $false -GroupIds "MyGroupIds" -RoleNames "MyRoleNames" -RolePermissions $RolePermission -LastLoginTime 0 -ExternalId "MyExternalId" -Links $Link $UserList = Initialize-VcfOpsUserList -Users $User Invoke-VcfOpsImportUsers -id "id_example" -userList $userList </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsImportUsers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UserList = Initialize-VcfOpsUserList Invoke-VcfOpsImportUsers -id "id_example" -userList $userList </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsImportUsers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/id/users/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuserlist</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-VcfOpsModifyScope</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsModifyScope</command:noun> <maml:description> <maml:para>Modify a Scope</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Modify a Scope</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsModifyScope</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Scope Details to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Scope</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Scope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Scope Details to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Scope</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Scope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Scope</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Scope = Initialize-VcfOpsScope -Id "MyId" -Name "MyName" -Description "MyDescription" -TraversalSpecInstances $TraversalSpecInstance Invoke-VcfOpsModifyScope -scope $scope </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyScope with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Scope = Initialize-VcfOpsScope -Name "MyName" Invoke-VcfOpsModifyScope -scope $scope </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyScope with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/scopes/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsscope</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-VcfOpsModifyUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsModifyUser</command:noun> <maml:description> <maml:para>Modify the details of a particular user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Modify the details of a particular user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsModifyUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The user object that is being modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.User</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>The user object that is being modified</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.User</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>VMware.Bindings.Vcf.Ops.Model.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link $User = Initialize-VcfOpsUser -Id "MyId" -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Password "MyPassword" -EmailAddress "MyEmailAddress" -DistinguishedName "MyDistinguishedName" -Enabled $false -GroupIds "MyGroupIds" -RoleNames "MyRoleNames" -RolePermissions $RolePermission -LastLoginTime 0 -ExternalId "MyExternalId" -Links $Link Invoke-VcfOpsModifyUser -user $user </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$User = Initialize-VcfOpsUser -Username "MyUsername" -Password "MyPassword" Invoke-VcfOpsModifyUser -user $user </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/users/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuser</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-VcfOpsModifyUserGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsModifyUserGroup</command:noun> <maml:description> <maml:para>Modify a local user group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>You can add or remove users from the group. Name and id of the group cannot be changed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsModifyUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserGroup</maml:name> <maml:Description> <maml:para>The group object to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserGroup</maml:name> <maml:Description> <maml:para>The group object to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link $UserGroup = Initialize-VcfOpsUserGroup -Id "MyId" -AuthSourceId "MyAuthSourceId" -Name "MyName" -Description "MyDescription" -DisplayName "MyDisplayName" -UserIds "MyUserIds" -RoleNames "MyRoleNames" -RolePermissions $RolePermission -ExternalId "MyExternalId" -Links $Link Invoke-VcfOpsModifyUserGroup -userGroup $userGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyUserGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UserGroup = Initialize-VcfOpsUserGroup -Name "MyName" Invoke-VcfOpsModifyUserGroup -userGroup $userGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyUserGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsusergroup</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-VcfOpsPatchAuthSourceWithCertificateDetails</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPatchAuthSourceWithCertificateDetails</command:noun> <maml:description> <maml:para>Patch an already added authentication source with the certificate data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Patch an already added authentication source with the certificate data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPatchAuthSourceWithCertificateDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>Contains authSource's type and its properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>Contains authSource's type and its properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Description "MyDescription" -Required $false -Modifiable $false $Properties = Initialize-VcfOpsProperties -Property $AuthSourceProperty $AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" -Description "MyDescription" -Links $Link -Properties $Properties $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AuthSource = Initialize-VcfOpsAuthSource -Id "MyId" -Name "MyName" -SourceType $AuthSourcetype -Created 0 -LastModified 0 -Links $Link -Property $NameValue -Certificates $Certificate Invoke-VcfOpsPatchAuthSourceWithCertificateDetails -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchAuthSourceWithCertificateDetails with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate $AuthSource = Initialize-VcfOpsAuthSource -Name "MyName" -SourceType $AuthSourcetype -Property $NameValue -Certificates $Certificate Invoke-VcfOpsPatchAuthSourceWithCertificateDetails -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchAuthSourceWithCertificateDetails with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/patch//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsauthsource</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-VcfOpsPatchTestAuthSource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPatchTestAuthSource</command:noun> <maml:description> <maml:para>Patch an already tested authentication source with the certificate data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Patch an already tested authentication source with the certificate data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPatchTestAuthSource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>Auth source object containing authSource ID, authSource type ,the properties of the auth source and certificate details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>Auth source object containing authSource ID, authSource type ,the properties of the auth source and certificate details</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Description "MyDescription" -Required $false -Modifiable $false $Properties = Initialize-VcfOpsProperties -Property $AuthSourceProperty $AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" -Description "MyDescription" -Links $Link -Properties $Properties $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AuthSource = Initialize-VcfOpsAuthSource -Id "MyId" -Name "MyName" -SourceType $AuthSourcetype -Created 0 -LastModified 0 -Links $Link -Property $NameValue -Certificates $Certificate Invoke-VcfOpsPatchTestAuthSource -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchTestAuthSource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate $AuthSource = Initialize-VcfOpsAuthSource -Name "MyName" -SourceType $AuthSourcetype -Property $NameValue -Certificates $Certificate Invoke-VcfOpsPatchTestAuthSource -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchTestAuthSource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/test/patch//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsauthsource</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-VcfOpsReleaseToken</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsReleaseToken</command:noun> <maml:description> <maml:para>Terminate the current sessionId</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Terminate the current Session ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsReleaseToken</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-VcfOpsReleaseToken </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsReleaseToken with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsReleaseToken </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsReleaseToken with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/token/release/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-VcfOpsRemoveRolePrivileges</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsRemoveRolePrivileges</command:noun> <maml:description> <maml:para>Remove specified privileges from the user role</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove specified privileges from the user role</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsRemoveRolePrivileges</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrivilegeKeys</maml:name> <maml:Description> <maml:para>The list of privileges to remove</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrivilegeKeys</maml:name> <maml:Description> <maml:para>The list of privileges to remove</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PrivilegeKeys = Initialize-VcfOpsPrivilegeKeys -PrivilegeKey "MyPrivilegeKey" Invoke-VcfOpsRemoveRolePrivileges -roleName "roleName_example" -privilegeKeys $privilegeKeys </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRemoveRolePrivileges with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PrivilegeKeys = Initialize-VcfOpsPrivilegeKeys -PrivilegeKey "MyPrivilegeKey" Invoke-VcfOpsRemoveRolePrivileges -roleName "roleName_example" -privilegeKeys $privilegeKeys </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRemoveRolePrivileges with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/roles/roleName/privileges/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsprivilegekeys</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-VcfOpsSearchUserGroupsForAuthSource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSearchUserGroupsForAuthSource</command:noun> <maml:description> <maml:para>Search user-groups for an auth source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The auth source can be SSO/VIDM/LDAP/AD. <br/>For the <i>LDAP/AD</i> auth source, the request should contain the name of the group.<br/>For the <i>SSO/VIDM</i> auth source, request should contain the name of the group and the SSO/VIDM domain.<br/>User-group's name can contain wildcards. Maximum of 25 user-groups are returned for SSO auth source. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSearchUserGroupsForAuthSource</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 auth source</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>UsergroupSearchRequest</maml:name> <maml:Description> <maml:para>The query object for user group search<br/> <i>Notes</i> Examples for LDAP/SSO user groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UsergroupSearchRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UsergroupSearchRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 auth source</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>UsergroupSearchRequest</maml:name> <maml:Description> <maml:para>The query object for user group search<br/> <i>Notes</i> Examples for LDAP/SSO user groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UsergroupSearchRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UsergroupSearchRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UsergroupSearchResponses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UsergroupSearchRequest = Initialize-VcfOpsUsergroupSearchRequest -Name "MyName" -Domain "MyDomain" Invoke-VcfOpsSearchUserGroupsForAuthSource -id "id_example" -usergroupSearchRequest $usergroupSearchRequest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSearchUserGroupsForAuthSource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UsergroupSearchRequest = Initialize-VcfOpsUsergroupSearchRequest -Name "MyName" Invoke-VcfOpsSearchUserGroupsForAuthSource -id "id_example" -usergroupSearchRequest $usergroupSearchRequest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSearchUserGroupsForAuthSource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/id/usergroups/search/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsusergroupsearchrequest</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-VcfOpsSearchUsersForAuthSource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSearchUsersForAuthSource</command:noun> <maml:description> <maml:para>Search users for an auth source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The auth source can be SSO/LDAP/AD/VIDM. <br/>For the <i>LDAP/AD</i> auth source, the request should contain the name of the user.<br/>For the <i>SSO/VIDM</i> auth source, request should contain the name of the user and the SSO/VIDM domain.<br/>Username can contain wildcards. Maximum of 25 users are returned for SSO auth source. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSearchUsersForAuthSource</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 auth source</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>UserSearchRequest</maml:name> <maml:Description> <maml:para>The query object for user search<br/> <i>Notes</i> Examples for LDAP/SSO users</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserSearchRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserSearchRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 auth source</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>UserSearchRequest</maml:name> <maml:Description> <maml:para>The query object for user search<br/> <i>Notes</i> Examples for LDAP/SSO users</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserSearchRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserSearchRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserSearchResponses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UserSearchRequest = Initialize-VcfOpsUserSearchRequest -Name "MyName" -Domain "MyDomain" Invoke-VcfOpsSearchUsersForAuthSource -id "id_example" -userSearchRequest $userSearchRequest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSearchUsersForAuthSource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UserSearchRequest = Initialize-VcfOpsUserSearchRequest -Name "MyName" Invoke-VcfOpsSearchUsersForAuthSource -id "id_example" -userSearchRequest $userSearchRequest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSearchUsersForAuthSource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/id/users/search/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsusersearchrequest</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-VcfOpsSetRolePrivileges</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSetRolePrivileges</command:noun> <maml:description> <maml:para>Set the privileges for a user role</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Replaces any previous privileges.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSetRolePrivileges</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrivilegeKeys</maml:name> <maml:Description> <maml:para>The list of privileges to be set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The name 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrivilegeKeys</maml:name> <maml:Description> <maml:para>The list of privileges to be set</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PrivilegeKeys</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PrivilegeKeys = Initialize-VcfOpsPrivilegeKeys -PrivilegeKey "MyPrivilegeKey" Invoke-VcfOpsSetRolePrivileges -roleName "roleName_example" -privilegeKeys $privilegeKeys </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetRolePrivileges with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PrivilegeKeys = Initialize-VcfOpsPrivilegeKeys -PrivilegeKey "MyPrivilegeKey" Invoke-VcfOpsSetRolePrivileges -roleName "roleName_example" -privilegeKeys $privilegeKeys </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetRolePrivileges with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/roles/roleName/privileges/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsprivilegekeys</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-VcfOpsSynchronizeUserGroups</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSynchronizeUserGroups</command:noun> <maml:description> <maml:para>Synchronize user groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Synchronize user groups by specified Auth Source ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSynchronizeUserGroups</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 Auth source</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>The ID of the Auth source</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsSynchronizeUserGroups -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSynchronizeUserGroups with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsSynchronizeUserGroups -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSynchronizeUserGroups with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/id/usergroups/synchronize/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-VcfOpsTestAuthSource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsTestAuthSource</command:noun> <maml:description> <maml:para>Test a new or an existing authentication source in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Test a new or an existing authentication source in the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsTestAuthSource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>Auth source object containing authSource type and the properties of the auth source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>Auth source object containing authSource type and the properties of the auth source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Description "MyDescription" -Required $false -Modifiable $false $Properties = Initialize-VcfOpsProperties -Property $AuthSourceProperty $AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" -Description "MyDescription" -Links $Link -Properties $Properties $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AuthSource = Initialize-VcfOpsAuthSource -Id "MyId" -Name "MyName" -SourceType $AuthSourcetype -Created 0 -LastModified 0 -Links $Link -Property $NameValue -Certificates $Certificate Invoke-VcfOpsTestAuthSource -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestAuthSource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate $AuthSource = Initialize-VcfOpsAuthSource -Name "MyName" -SourceType $AuthSourcetype -Property $NameValue -Certificates $Certificate Invoke-VcfOpsTestAuthSource -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestAuthSource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/test/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsauthsource</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-VcfOpsUnassignedRolePermissionFromUser</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUnassignedRolePermissionFromUser</command:noun> <maml:description> <maml:para>Unassign role permission from a user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unassign role permission from a user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUnassignedRolePermissionFromUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>Identifier of the user from which the role permission needs to be unassigned</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>RoleName</maml:name> <maml:Description> <maml:para>The name of the role permission to be unassigned</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>UserId</maml:name> <maml:Description> <maml:para>Identifier of the user from which the role permission needs to be unassigned</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>RoleName</maml:name> <maml:Description> <maml:para>The name of the role permission to be unassigned</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsUnassignedRolePermissionFromUser -userId "userId_example" -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnassignedRolePermissionFromUser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUnassignedRolePermissionFromUser -userId "userId_example" -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnassignedRolePermissionFromUser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/users/userId/permissions/roleName/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-VcfOpsUnassignedRolePermissionFromUserGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUnassignedRolePermissionFromUserGroup</command:noun> <maml:description> <maml:para>Unassign role permission from a user group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unassign role permission from a user group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUnassignedRolePermissionFromUserGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>The Identifier of the user group</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>RoleName</maml:name> <maml:Description> <maml:para>The name of the role permission to be unassigned</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>GroupId</maml:name> <maml:Description> <maml:para>The Identifier of the user group</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>RoleName</maml:name> <maml:Description> <maml:para>The name of the role permission to be unassigned</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsUnassignedRolePermissionFromUserGroup -groupId "groupId_example" -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnassignedRolePermissionFromUserGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUnassignedRolePermissionFromUserGroup -groupId "groupId_example" -roleName "roleName_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnassignedRolePermissionFromUserGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/usergroups/groupId/permissions/roleName/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-VcfOpsUpdateAuthSource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateAuthSource</command:noun> <maml:description> <maml:para>Update an authentication source in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the host is an ldap host and if host/port is changed, then the response will contain a list of certificates found matching with the host. It is the duty of the caller to call the PATCH (/sources) api with the certificate details. Once the PATCH api call is successful, the authentication source is available for use.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateAuthSource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>AuthSource object that contains authSource's ID, type, its properties and list of certificate details if ssl is enabled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AuthSource</maml:name> <maml:Description> <maml:para>AuthSource object that contains authSource's ID, type, its properties and list of certificate details if ssl is enabled</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Description "MyDescription" -Required $false -Modifiable $false $Properties = Initialize-VcfOpsProperties -Property $AuthSourceProperty $AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" -Description "MyDescription" -Links $Link -Properties $Properties $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AuthSource = Initialize-VcfOpsAuthSource -Id "MyId" -Name "MyName" -SourceType $AuthSourcetype -Created 0 -LastModified 0 -Links $Link -Property $NameValue -Certificates $Certificate Invoke-VcfOpsUpdateAuthSource -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateAuthSource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate $AuthSource = Initialize-VcfOpsAuthSource -Name "MyName" -SourceType $AuthSourcetype -Property $NameValue -Certificates $Certificate Invoke-VcfOpsUpdateAuthSource -authSource $authSource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateAuthSource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/sources/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsauthsource</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-VcfOpsUpdateUserRole</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateUserRole</command:noun> <maml:description> <maml:para>Update a user role</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Name of the role cannot be changed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateUserRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserRole</maml:name> <maml:Description> <maml:para>The UserRole object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserRole</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserRole</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserRole</maml:name> <maml:Description> <maml:para>The UserRole object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UserRole</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserRole</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UserRole</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $UserRole = Initialize-VcfOpsUserRole -Name "MyName" -Description "MyDescription" -DisplayName "MyDisplayName" -PrivilegeKeys "MyPrivilegeKeys" -SystemCreated $false -Links $Link Invoke-VcfOpsUpdateUserRole -userRole $userRole </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateUserRole with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UserRole = Initialize-VcfOpsUserRole -Name "MyName" Invoke-VcfOpsUpdateUserRole -userRole $userRole </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateUserRole with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/auth/roles/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuserrole</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-VcfOpsDeleteCertificate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteCertificate</command:noun> <maml:description> <maml:para>Delete a certificate</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a certificate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Thumbprint</maml:name> <maml:Description> <maml:para>The Certificate thumbprint to be deleted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Indicates whether to force delete operation if there are references to 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>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>Thumbprint</maml:name> <maml:Description> <maml:para>The Certificate thumbprint to be deleted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Indicates whether to force delete operation if there are references to 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>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-VcfOpsDeleteCertificate -thumbprint "thumbprint_example" -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCertificate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteCertificate -thumbprint "thumbprint_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCertificate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/certificate/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-VcfOpsGetAllCertificates</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAllCertificates</command:noun> <maml:description> <maml:para>Get all certificates</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all certificates</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAllCertificates</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Certificates</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAllCertificates </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAllCertificates with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAllCertificates </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAllCertificates with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/certificate/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-VcfOpsImportCertificate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsImportCertificate</command:noun> <maml:description> <maml:para>Import certificate file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import the given certificate file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsImportCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>Certificate 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateFile</maml:name> <maml:Description> <maml:para>Certificate 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Certificates</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsImportCertificate -certificateFile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsImportCertificate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsImportCertificate -certificateFile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsImportCertificate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/certificate/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-VcfOpsDeleteBill</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteBill</command:noun> <maml:description> <maml:para>Delete generated bill for the specified bill identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteBill</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The bill identifier</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>The bill identifier</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteBill -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteBill with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteBill -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteBill with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/bills/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-VcfOpsGenerateBills</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGenerateBills</command:noun> <maml:description> <maml:para>Create and save the Bills based on the Bill Generate Request</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create and save the Bills based on the Bill Generate Request</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGenerateBills</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BillGenerationRequest</maml:name> <maml:Description> <maml:para>The calculation param for resources metering by policy assignments</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.BillGenerationRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.BillGenerationRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BillGenerationRequest</maml:name> <maml:Description> <maml:para>The calculation param for resources metering by policy assignments</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.BillGenerationRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.BillGenerationRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.BillGenerationResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BillGenerationRequestTimeZone = Initialize-VcfOpsBillGenerationRequestTimeZone -DisplayName "MyDisplayName" -Id "MyId" -Dstsavings 0 -RawOffset 0 $BillGenerationRequest = Initialize-VcfOpsBillGenerationRequest -Title "MyTitle" -Description "MyDescription" -BillingStartTime 0 -BillingEndTime 0 -ResourceIds "MyResourceIds" -PolicyId "MyPolicyId" -TimeZone $BillGenerationRequestTimeZone Invoke-VcfOpsGenerateBills -billGenerationRequest $billGenerationRequest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGenerateBills with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BillGenerationRequestTimeZone = Initialize-VcfOpsBillGenerationRequestTimeZone $BillGenerationRequest = Initialize-VcfOpsBillGenerationRequest -Title "MyTitle" -BillingStartTime 0 -BillingEndTime 0 -ResourceIds "MyResourceIds" -TimeZone $BillGenerationRequestTimeZone Invoke-VcfOpsGenerateBills -billGenerationRequest $billGenerationRequest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGenerateBills with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/bills/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsbillgenerationrequest</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-VcfOpsGetBill</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetBill</command:noun> <maml:description> <maml:para>Get bill for the specified bill identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetBill</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the bill</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>The identifier of the bill</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>VMware.Bindings.Vcf.Ops.Model.MeteringBill</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetBill -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetBill with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetBill -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetBill with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/bills/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-VcfOpsGetBillSummary</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetBillSummary</command:noun> <maml:description> <maml:para>Get metering Bills summary based on the Request</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get metering Bills summary based on the Request</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetBillSummary</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BillSummaryRequest</maml:name> <maml:Description> <maml:para>The Billing Summary Request which supports sort, search and filter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.BillSummaryRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.BillSummaryRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Sort the result based on any of the field</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortOrder</maml:name> <maml:Description> <maml:para>Sort Order for the results</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DESC</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BillSummaryRequest</maml:name> <maml:Description> <maml:para>The Billing Summary Request which supports sort, search and filter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.BillSummaryRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.BillSummaryRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Sort the result based on any of the field</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortOrder</maml:name> <maml:Description> <maml:para>Sort Order for the results</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DESC</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.MeteringBillSummaries</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DateRange = Initialize-VcfOpsDateRange -Start 0 -End 0 $SearchCriteria = Initialize-VcfOpsSearchCriteria -Key "RESOURCE_NAME" -Value "MyValue" $BillSummaryRequest = Initialize-VcfOpsBillSummaryRequest -Period $DateRange -SearchCriterias $SearchCriteria Invoke-VcfOpsGetBillSummary -billSummaryRequest $billSummaryRequest -page 0 -pageSize 1000 -sortBy "RESOURCE_NAME" -sortOrder "ASC" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetBillSummary with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BillSummaryRequest = Initialize-VcfOpsBillSummaryRequest Invoke-VcfOpsGetBillSummary -billSummaryRequest $billSummaryRequest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetBillSummary with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/bills/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsbillsummaryrequest</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-VcfOpsCreateChargeBackReport</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateChargeBackReport</command:noun> <maml:description> <maml:para>Generate (create) a Chargeback Report using the specified Report Definition and for the specified Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generate (create) a Chargeback Report using the specified Report Definition and for the specified Resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateChargeBackReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Report</maml:name> <maml:Description> <maml:para>The Chargeback Report that needs to be generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Report</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Report</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Report</maml:name> <maml:Description> <maml:para>The Chargeback Report that needs to be generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Report</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Report</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Report</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $Report = Initialize-VcfOpsReport -Id "MyId" -Name "MyName" -Description "MyDescription" -ResourceId "MyResourceId" -ReportDefinitionId "MyReportDefinitionId" -TraversalSpec $TraversalSpec -Subject "MySubject" -Owner "MyOwner" -CompletionTime "MyCompletionTime" -Status "MyStatus" -Links $Link Invoke-VcfOpsCreateChargeBackReport -report $report </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateChargeBackReport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Report = Initialize-VcfOpsReport -ResourceId "MyResourceId" -ReportDefinitionId "MyReportDefinitionId" Invoke-VcfOpsCreateChargeBackReport -report $report </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateChargeBackReport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reports/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsreport</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-VcfOpsCreateReportScheduleById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateReportScheduleById</command:noun> <maml:description> <maml:para>Create a Chargeback Report Schedule to generate a Report for the specified Report Definition and Resource(s)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>To specify the time zone add <i>X-Ops-API-Timezone</i> header with value of format e.g. Asia/Yerevan.<br/>All the schedules created using this API will be configured to use GMT time zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateReportScheduleById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Chargeback Report Definition identifier</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>ChargebackReportSchedule</maml:name> <maml:Description> <maml:para>The Chargeback Report Schedule to create in the system</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>XOpsAPITimezone</maml:name> <maml:Description> <maml:para>Custom HTTP header used by Ops API clients to specify Timezone information.<br/>This Timezone value will be typically used for Report Generation.<br/>Either an abbreviation such as \"GMT\", \"PDT\" can be specified,<br/>or a full name such as \"America/Los_Angeles\". Other<br/>formats and representations are not supported.<br/></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"GMT"</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 Chargeback Report Definition identifier</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>ChargebackReportSchedule</maml:name> <maml:Description> <maml:para>The Chargeback Report Schedule to create in the system</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>XOpsAPITimezone</maml:name> <maml:Description> <maml:para>Custom HTTP header used by Ops API clients to specify Timezone information.<br/>This Timezone value will be typically used for Report Generation.<br/>Either an abbreviation such as \"GMT\", \"PDT\" can be specified,<br/>or a full name such as \"America/Los_Angeles\". Other<br/>formats and representations are not supported.<br/></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"GMT"</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"UNKNOWN"$ChargebackReportSchedule = Initialize-VcfOpsChargebackReportSchedule -Id "MyId" -ResourceIds "MyResourceIds" -StartDate "MyStartDate" -WeekOfMonth "UNKNOWNN" -ReportScheduleType "UNKNOWN" -DaysOfTheWeek "UNKNOWN" -StartHour 0 -StartMinute 0 -Recurrence 0 -DayOfTheMonth 0 Invoke-VcfOpsCreateReportScheduleById -id "id_example" -chargebackReportSchedule $chargebackReportSchedule -xOpsAPITimezone "\"GMT\"" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateReportScheduleById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ChargebackReportSchedule = Initialize-VcfOpsChargebackReportSchedule -ResourceIds "MyResourceIds" -StartDate "MyStartDate" -ReportScheduleType "UNKNOWN" -Recurrence 0 Invoke-VcfOpsCreateReportScheduleById -id "id_example" -chargebackReportSchedule $chargebackReportSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateReportScheduleById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reportdefinitions/id/schedules/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpschargebackreportschedule</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-VcfOpsDeleteChargeBackReport</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteChargeBackReport</command:noun> <maml:description> <maml:para>Delete a chargeback report by its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a chargeback report by its identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteChargeBackReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Report identifier</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>Report identifier</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteChargeBackReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteChargeBackReport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteChargeBackReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteChargeBackReport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reports/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-VcfOpsDeleteScheduleById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteScheduleById</command:noun> <maml:description> <maml:para>Delete Chargeback Report Schedule associated with the specific Report Definition and for the specified Schedule identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete Chargeback Report Schedule associated with the specific Report Definition and for the specified Schedule identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteScheduleById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Chargeback Report Definition identifier</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>ScheduleId</maml:name> <maml:Description> <maml:para>The Chargeback Report Schedule identifier</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>The Chargeback Report Definition identifier</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>ScheduleId</maml:name> <maml:Description> <maml:para>The Chargeback Report Schedule identifier</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteScheduleById -id "id_example" -scheduleId "scheduleId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteScheduleById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteScheduleById -id "id_example" -scheduleId "scheduleId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteScheduleById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reportdefinitions/id/schedules/scheduleId/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-VcfOpsDownloadChargeBackReport</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDownloadChargeBackReport</command:noun> <maml:description> <maml:para>Download the Chargeback Report given its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The supported formats for Chargeback Reports are PDF, CSV. If the format is not<br>specified the downloaded report will be in PDF format.<br> <b>NOTE:</b> In case the Accept header is provided, ensure that its value corresponds to the 'format' request parameter (including the default value when the request parameter is omitted).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDownloadChargeBackReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the Chargeback Report</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>Format</maml:name> <maml:Description> <maml:para>The format of the Chargeback Report</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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 Identifier of the Chargeback Report</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>Format</maml:name> <maml:Description> <maml:para>The format of the Chargeback Report</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml: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-VcfOpsDownloadChargeBackReport -id "id_example" -format "format_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownloadChargeBackReport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDownloadChargeBackReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownloadChargeBackReport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reports/id/download/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-VcfOpsGetChargeBackReport</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetChargeBackReport</command:noun> <maml:description> <maml:para>Get the detail of a Chargeback Report given its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the detail of a Chargeback Report given its identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetChargeBackReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the Chargeback Report</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>The Identifier of the Chargeback Report</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>VMware.Bindings.Vcf.Ops.Model.Report</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetChargeBackReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetChargeBackReport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetChargeBackReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetChargeBackReport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reports/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-VcfOpsGetChargeBackReports</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetChargeBackReports</command:noun> <maml:description> <maml:para>Get the Chargeback Reports based on the Report Query Spec provided</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the query spec is not provided, all Chargeback Reports present in the system are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetChargeBackReports</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Reports name with which the filtering can be done</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>Subject</maml:name> <maml:Description> <maml:para>Subjects with which the filtering can be done</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>Status</maml:name> <maml:Description> <maml:para>Status of the report</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>ResourceId</maml:name> <maml:Description> <maml:para>Resources on which the reports are generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>Reports name with which the filtering can be done</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>Subject</maml:name> <maml:Description> <maml:para>Subjects with which the filtering can be done</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>Status</maml:name> <maml:Description> <maml:para>Status of the report</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>ResourceId</maml:name> <maml:Description> <maml:para>Resources on which the reports are generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Reports</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetChargeBackReports -name "Myname" -subject "Mysubject" -status "Mystatus" -resourceId "MyresourceId" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetChargeBackReports with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetChargeBackReports </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetChargeBackReports with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reports/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-VcfOpsGetReportScheduleById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetReportScheduleById</command:noun> <maml:description> <maml:para>Get a specific Chargeback Report Schedule for the specified Report Definition and Schedule identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The date and time values configured within the Report Schedule are converted to GMT time zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetReportScheduleById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Chargeback Report Definition identifier</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>ScheduleId</maml:name> <maml:Description> <maml:para>The Report Schedule identifier</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>The Chargeback Report Definition identifier</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>ScheduleId</maml:name> <maml:Description> <maml:para>The Report Schedule identifier</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>VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetReportScheduleById -id "id_example" -scheduleId "scheduleId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportScheduleById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetReportScheduleById -id "id_example" -scheduleId "scheduleId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportScheduleById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reportdefinitions/id/schedules/scheduleId/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-VcfOpsGetReportSchedulesById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetReportSchedulesById</command:noun> <maml:description> <maml:para>Get all the Chargeback Report Schedules associated with a Report Definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The date and time values configured within the Report Schedule are converted to GMT time zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetReportSchedulesById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Chargeback Report Definition identifier</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>IncludeResourcelessSchedules</maml:name> <maml:Description> <maml:para>Flag to include schedules with not-existing resource</maml:para> </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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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 Chargeback Report Definition identifier</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>IncludeResourcelessSchedules</maml:name> <maml:Description> <maml:para>Flag to include schedules with not-existing resource</maml:para> </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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedules</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetReportSchedulesById -id "id_example" -includeResourcelessSchedules $false -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportSchedulesById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetReportSchedulesById -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportSchedulesById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reportdefinitions/id/schedules/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-VcfOpsUpdateReportScheduleById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateReportScheduleById</command:noun> <maml:description> <maml:para>Update Chargeback Report Schedule associated with the specific Report Definition and for the specified Schedule identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The update of a schedule is a \"Replace\" operation.<br/>If a schedule with the specified <br/>schedule id is present in the system it will be replaced else the API returns a 404 error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateReportScheduleById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Chargeback Report Definition identifier</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>ChargebackReportSchedule</maml:name> <maml:Description> <maml:para>The Chargeback Report Schedule to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 Chargeback Report Definition identifier</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>ChargebackReportSchedule</maml:name> <maml:Description> <maml:para>The Chargeback Report Schedule to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ChargebackReportSchedule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"UNKNOWN"$ChargebackReportSchedule = Initialize-VcfOpsChargebackReportSchedule -Id "MyId" -ResourceIds "MyResourceIds" -StartDate "MyStartDate" -WeekOfMonth "UNKNOWNN" -ReportScheduleType "UNKNOWN" -DaysOfTheWeek "UNKNOWN" -StartHour 0 -StartMinute 0 -Recurrence 0 -DayOfTheMonth 0 Invoke-VcfOpsUpdateReportScheduleById -id "id_example" -chargebackReportSchedule $chargebackReportSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateReportScheduleById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ChargebackReportSchedule = Initialize-VcfOpsChargebackReportSchedule -ResourceIds "MyResourceIds" -StartDate "MyStartDate" -ReportScheduleType "UNKNOWN" -Recurrence 0 Invoke-VcfOpsUpdateReportScheduleById -id "id_example" -chargebackReportSchedule $chargebackReportSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateReportScheduleById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/chargeback/reportdefinitions/id/schedules/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpschargebackreportschedule</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-VcfOpsAddCollectorToCollectorGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddCollectorToCollectorGroup</command:noun> <maml:description> <maml:para>Add a Collector to Collector Group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add a Collector to the specified Collector Group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddCollectorToCollectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of the Collector Group</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>CollectorId</maml:name> <maml:Description> <maml:para>Identifier (an integer) of the Collector</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>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group update</maml:para> </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>Identifier of the Collector Group</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>CollectorId</maml:name> <maml:Description> <maml:para>Identifier (an integer) of the Collector</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>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group update</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.CollectorGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsAddCollectorToCollectorGroup -id "id_example" -collectorId 56 -checkCollectorMembers $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddCollectorToCollectorGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsAddCollectorToCollectorGroup -id "id_example" -collectorId 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddCollectorToCollectorGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectorgroups/id/collector/collectorId/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-VcfOpsCreateCollectorGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateCollectorGroup</command:noun> <maml:description> <maml:para>Create a new Collector Group in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new Collector Group in the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateCollectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroup</maml:name> <maml:Description> <maml:para>The Collector Group that needs to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CollectorGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CollectorGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group 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>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>CollectorGroup</maml:name> <maml:Description> <maml:para>The Collector Group that needs to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CollectorGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CollectorGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group 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>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CollectorGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $CollectorGroup = Initialize-VcfOpsCollectorGroup -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId 0 -SystemDefined $false -Links $Link -HaEnabled $false -LbEnabled $false -VirtualIP "MyVirtualIP" Invoke-VcfOpsCreateCollectorGroup -collectorGroup $collectorGroup -checkCollectorMembers $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCollectorGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CollectorGroup = Initialize-VcfOpsCollectorGroup -Id "MyId" -Name "MyName" Invoke-VcfOpsCreateCollectorGroup -collectorGroup $collectorGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCollectorGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectorgroups/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscollectorgroup</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-VcfOpsDeleteCollectorGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteCollectorGroup</command:noun> <maml:description> <maml:para>Delete a Collector Group from the system using its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a Collector Group from the system using collector specified identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteCollectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of the Collector Group to delete</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>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group update</maml:para> </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>Identifier of the Collector Group to delete</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>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group update</maml:para> </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-VcfOpsDeleteCollectorGroup -id "id_example" -checkCollectorMembers $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCollectorGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteCollectorGroup -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCollectorGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectorgroups/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-VcfOpsGetCollectorGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCollectorGroup</command:noun> <maml:description> <maml:para>Get details of a particular Collector Group in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details of a particular Collector Group in the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCollectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of the Collector Group</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>Identifier of the Collector Group</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>VMware.Bindings.Vcf.Ops.Model.CollectorGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCollectorGroup -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCollectorGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCollectorGroup -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCollectorGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectorgroups/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-VcfOpsGetCollectorGroups</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCollectorGroups</command:noun> <maml:description> <maml:para>Enumerate all the Collector Groups defined in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all the Collector Groups defined in the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCollectorGroups</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CollectorGroups</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCollectorGroups </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCollectorGroups with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCollectorGroups </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCollectorGroups with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectorgroups/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-VcfOpsRemoveCollectorFromCollectorGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsRemoveCollectorFromCollectorGroup</command:noun> <maml:description> <maml:para>Remove a Collector from a Collector Group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a Collector from the specified Collector Group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsRemoveCollectorFromCollectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of the Collector Group</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>CollectorId</maml:name> <maml:Description> <maml:para>Identifier (an integer) of the Collector</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>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group update</maml:para> </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>Identifier of the Collector Group</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>CollectorId</maml:name> <maml:Description> <maml:para>Identifier (an integer) of the Collector</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>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group update</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.CollectorGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsRemoveCollectorFromCollectorGroup -id "id_example" -collectorId 56 -checkCollectorMembers $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRemoveCollectorFromCollectorGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsRemoveCollectorFromCollectorGroup -id "id_example" -collectorId 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRemoveCollectorFromCollectorGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectorgroups/id/collector/collectorId/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-VcfOpsUpdateCollectorGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateCollectorGroup</command:noun> <maml:description> <maml:para>Update a Collector Group in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Replaces all existing configuration of a Collector Group <br/>with the data specified as part of the Request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateCollectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroup</maml:name> <maml:Description> <maml:para>The Collector Group that needs to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CollectorGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CollectorGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group update</maml:para> </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>CollectorGroup</maml:name> <maml:Description> <maml:para>The Collector Group that needs to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CollectorGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CollectorGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CheckCollectorMembers</maml:name> <maml:Description> <maml:para>Check if collector group members are valid, before proceeding with collector group update</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.CollectorGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $CollectorGroup = Initialize-VcfOpsCollectorGroup -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId 0 -SystemDefined $false -Links $Link -HaEnabled $false -LbEnabled $false -VirtualIP "MyVirtualIP" Invoke-VcfOpsUpdateCollectorGroup -collectorGroup $collectorGroup -checkCollectorMembers $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateCollectorGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CollectorGroup = Initialize-VcfOpsCollectorGroup -Id "MyId" -Name "MyName" Invoke-VcfOpsUpdateCollectorGroup -collectorGroup $collectorGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateCollectorGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectorgroups/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscollectorgroup</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-VcfOpsDisableDataPersistence</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDisableDataPersistence</command:noun> <maml:description> <maml:para>Disable data persistence on cloud proxy</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can disable data persistence on cloud proxy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDisableDataPersistence</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the Collector</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>Id</maml:name> <maml:Description> <maml:para>The Identifier of the Collector</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>Invoke-VcfOpsDisableDataPersistence -id 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableDataPersistence with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDisableDataPersistence -id 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableDataPersistence with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectors/id/datapersistence/disable/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-VcfOpsEnableDataPersistence</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsEnableDataPersistence</command:noun> <maml:description> <maml:para>Enable data persistence on cloud proxy</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can enable data persistence on cloud proxy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsEnableDataPersistence</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the Collector</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>Id</maml:name> <maml:Description> <maml:para>The Identifier of the Collector</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>Invoke-VcfOpsEnableDataPersistence -id 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableDataPersistence with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsEnableDataPersistence -id 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableDataPersistence with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectors/id/datapersistence/enable/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-VcfOpsGetAdaptersOnCollector</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAdaptersOnCollector</command:noun> <maml:description> <maml:para>Get all the Collectors registered with the VMware Cloud Foundation Operations system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all the Collectors registered with the VMware Cloud Foundation Operations system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAdaptersOnCollector</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the Collector</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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 Identifier of the Collector</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterInstances</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAdaptersOnCollector -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdaptersOnCollector with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAdaptersOnCollector -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdaptersOnCollector with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectors/id/adapters/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-VcfOpsGetCollectors</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCollectors</command:noun> <maml:description> <maml:para>Get all the Collectors registered with the VMware Cloud Foundation Operations system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no filters set, the API returns all the Collectors registered with the VMware Cloud Foundation Operations system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCollectors</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Host</maml:name> <maml:Description> <maml:para>Optional list of host names to filter by</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>Host</maml:name> <maml:Description> <maml:para>Optional list of host names to filter by</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>VMware.Bindings.Vcf.Ops.Model.Collectors</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCollectors -host "Myhost" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCollectors with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCollectors </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCollectors with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/collectors/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-VcfOpsGet</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGet</command:noun> <maml:description> <maml:para>Get details of the specified configuration file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details of the specified configuration file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Configuration file path in {configFileType}/{fileName} format.<br>Allowed values for configFileType: TxtWidgetConfig (Text Widget Content), ReskndMetricConfig (Widget Metric Configuration), TopoWidgetConfig (Topology Widget Configuration) , SolutionConfig (Management Packs Configuration). <br><b>Note</b>: any sub folders, visible via UI, should be skipped in the 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>Path</maml:name> <maml:Description> <maml:para>Configuration file path in {configFileType}/{fileName} format.<br>Allowed values for configFileType: TxtWidgetConfig (Text Widget Content), ReskndMetricConfig (Widget Metric Configuration), TopoWidgetConfig (Topology Widget Configuration) , SolutionConfig (Management Packs Configuration). <br><b>Note</b>: any sub folders, visible via UI, should be skipped in the 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>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-VcfOpsGet -path "path_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGet with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGet -path "path_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGet with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/configurations/files/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-VcfOpsBackupContent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsBackupContent</command:noun> <maml:description> <maml:para>(Deprecated) Backup content for current user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Backup content for current user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsBackupContent</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-VcfOpsBackupContent </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsBackupContent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsBackupContent </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsBackupContent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/backup/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-VcfOpsDownload</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDownload</command:noun> <maml:description> <maml:para>Download the latest export</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Downloads the content data as a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDownload</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </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-VcfOpsDownload </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownload with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDownload </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownload with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/operations/export/zip/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-VcfOpsDownloadBackupContentData</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDownloadBackupContentData</command:noun> <maml:description> <maml:para>(Deprecated) Download backup for current user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Download backup for current user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDownloadBackupContentData</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </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-VcfOpsDownloadBackupContentData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownloadBackupContentData with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDownloadBackupContentData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownloadBackupContentData with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/backup/result/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-VcfOpsExportContent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsExportContent</command:noun> <maml:description> <maml:para>Export content for current user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export content for current user. This takes scope of the export. The content types that need to be exported can be specified as a list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsExportContent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContentExport</maml:name> <maml:Description> <maml:para>Export Details of Type and Segregation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ContentExport</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ContentExport</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EncryptionPassword</maml:name> <maml:Description> <maml:para>Key for encrypting sensitive information</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ContentExport</maml:name> <maml:Description> <maml:para>Export Details of Type and Segregation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ContentExport</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ContentExport</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EncryptionPassword</maml:name> <maml:Description> <maml:para>Key for encrypting sensitive information</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ContentExport</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"VIEW_DEFINITIONS" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ContentExport = Initialize-VcfOpsContentExport -Scope "ALL" -ContentTypes "VIEW_DEFINITIONS" -Links $Link Invoke-VcfOpsExportContent -contentExport $contentExport -encryptionPassword "encryptionPassword_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsExportContent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>"VIEW_DEFINITIONS" $ContentExport = Initialize-VcfOpsContentExport -Scope "ALL" -ContentTypes "VIEW_DEFINITIONS" Invoke-VcfOpsExportContent -contentExport $contentExport </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsExportContent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/operations/export/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscontentexport</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-VcfOpsGetContentProgress</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetContentProgress</command:noun> <maml:description> <maml:para>(Deprecated) Get content progress</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get content progress</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetContentProgress</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ContentProgress</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetContentProgress </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetContentProgress with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetContentProgress </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetContentProgress with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/progress/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-VcfOpsGetLastExportOperation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetLastExportOperation</command:noun> <maml:description> <maml:para>Get the last export operation details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The response contains information about the last export operation details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetLastExportOperation</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OperationDetails</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetLastExportOperation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLastExportOperation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetLastExportOperation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLastExportOperation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/operations/export/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-VcfOpsGetLastImportOperation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetLastImportOperation</command:noun> <maml:description> <maml:para>Get the last import operation details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The response contains information about the last import operation details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetLastImportOperation</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OperationDetails</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetLastImportOperation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLastImportOperation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetLastImportOperation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLastImportOperation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/operations/import/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-VcfOpsGetRestoreContentData</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetRestoreContentData</command:noun> <maml:description> <maml:para>(Deprecated) Get restore data report for current user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get restore data report for current user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetRestoreContentData</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Content</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetRestoreContentData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRestoreContentData with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetRestoreContentData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRestoreContentData with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/restore/result/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-VcfOpsImportContent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsImportContent</command:noun> <maml:description> <maml:para>Import content for current user from uploaded file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The \"Content-Type\" of the request is multipart/form-data. If the force option is set to true, content will be overwritten. By default the flag is true. <br/> <b>NOTE:</b> If the content file contains integration accounts, then upon completion of the import process, it is recommended to check them. Some collectors or collector groups may have become unbound from the accounts they serve and should be reconnected. Additionally, you will need to re-accept all untrusted certificates manually. Finally ensure that all your adapter instances are started as some of these may not have been restarted automatically.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsImportContent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContentFile</maml:name> <maml:Description> <maml:para>Multipart 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>EncryptionPassword</maml:name> <maml:Description> <maml:para>Key for decrypting sensitive information</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>True to force solution content overwrite</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContentFile</maml:name> <maml:Description> <maml:para>Multipart 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>EncryptionPassword</maml:name> <maml:Description> <maml:para>Key for decrypting sensitive information</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>True to force solution content overwrite</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ContentImport</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsImportContent -contentFile -encryptionPassword "encryptionPassword_example" -force $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsImportContent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsImportContent -contentFile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsImportContent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/operations/import/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-VcfOpsRestoreContent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsRestoreContent</command:noun> <maml:description> <maml:para>(Deprecated) Restore content for current user from uploaded file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The \"Content-Type\" of the request is multipart/form-data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsRestoreContent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContentFile</maml:name> <maml:Description> <maml:para>Multipart file, Multipart name should be \\\"contentFile\\\"</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>ForceContentUpdate</maml:name> <maml:Description> <maml:para>True to force solution content overwrite</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContentFile</maml:name> <maml:Description> <maml:para>Multipart file, Multipart name should be \\\"contentFile\\\"</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>ForceContentUpdate</maml:name> <maml:Description> <maml:para>True to force solution content overwrite</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsRestoreContent -contentFile -forceContentUpdate $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRestoreContent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsRestoreContent -contentFile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRestoreContent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/content/restore/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-VcfOpsGetCurrency</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCurrency</command:noun> <maml:description> <maml:para>Get details of currently selected currency such as display name, code, etc.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details of currently selected currency such as display name, code, etc.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCurrency</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Currency</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCurrency </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCurrency with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCurrency </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCurrency with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/costconfig/currency/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-VcfOpsSetCurrency</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSetCurrency</command:noun> <maml:description> <maml:para>Set currency</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set currency</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSetCurrency</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CurrencyConfig</maml:name> <maml:Description> <maml:para>The Currency configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CurrencyConfig</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CurrencyConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CurrencyConfig</maml:name> <maml:Description> <maml:para>The Currency configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CurrencyConfig</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CurrencyConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Currency</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CurrencyConfig = Initialize-VcfOpsCurrencyConfig -Code "MyCode" Invoke-VcfOpsSetCurrency -currencyConfig $currencyConfig </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetCurrency with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CurrencyConfig = Initialize-VcfOpsCurrencyConfig -Code "MyCode" Invoke-VcfOpsSetCurrency -currencyConfig $currencyConfig </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetCurrency with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/costconfig/currency/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscurrencyconfig</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-VcfOpsCreateCredential</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateCredential</command:noun> <maml:description> <maml:para>Create a new Credential Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new Credential Instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>The Credential Instance information</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Credential</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Credential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>The Credential Instance information</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Credential</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Credential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Credential = Initialize-VcfOpsCredential -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" -Fields $NameValue -Editable $false Invoke-VcfOpsCreateCredential -credential $credential </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Credential = Initialize-VcfOpsCredential -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" Invoke-VcfOpsCreateCredential -credential $credential </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/credentials/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscredential</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-VcfOpsDeleteCredential</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteCredential</command:noun> <maml:description> <maml:para>Delete a Credential Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a Credential Instance using the identifier specified. Requires the authenticated user to have correct privilege.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the specific Credential Instance</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>The identifier of the specific Credential Instance</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteCredential -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteCredential -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/credentials/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-VcfOpsGetAdapterInstancesUsingCredential</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAdapterInstancesUsingCredential</command:noun> <maml:description> <maml:para>Get all Adapter Instances using the Credential Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the Adapter Instances using the Credential Instance specified by the identifier.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAdapterInstancesUsingCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the specific Credential Instance</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>The identifier of the specific Credential Instance</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>VMware.Bindings.Vcf.Ops.Model.AdapterInstances</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAdapterInstancesUsingCredential -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterInstancesUsingCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAdapterInstancesUsingCredential -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterInstancesUsingCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/credentials/id/adapters/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-VcfOpsGetCredential</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCredential</command:noun> <maml:description> <maml:para>Get a Credential Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Credential Instance using the identifier specified</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the specific Credential Instance</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>The identifier of the specific Credential Instance</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>VMware.Bindings.Vcf.Ops.Model.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-VcfOpsGetCredential -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCredential -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/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-VcfOpsGetCredentialKinds</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCredentialKinds</command:noun> <maml:description> <maml:para>Get all Credential Kinds defined in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all the Credential Kinds defined in the system. Optionally filter by adapter kind keys.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCredentialKinds</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>Filter by Adapter Kind 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>Filter by Adapter Kind 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CredentialKinds</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCredentialKinds -adapterKind "MyadapterKind" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCredentialKinds with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCredentialKinds </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCredentialKinds with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/credentialkinds/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-VcfOpsGetCredentials</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCredentials</command:noun> <maml:description> <maml:para>Get all Credential Instances in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all the Credential Instances in the system. Optionally filter by adapter kind keys or credential instance identifiers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCredentials</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Filter by Credential Instance Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterKind</maml:name> <maml:Description> <maml:para>Filter by Adapter Kind Id</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>Filter by Credential Instance Id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterKind</maml:name> <maml:Description> <maml:para>Filter by Adapter Kind Id</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>VMware.Bindings.Vcf.Ops.Model.CredentialInstances</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCredentials -id "Myid" -adapterKind "MyadapterKind" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCredentials with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCredentials </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCredentials with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/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-VcfOpsGetResourcesUsingCredential</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourcesUsingCredential</command:noun> <maml:description> <maml:para>Get the Objects using the Credential Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the Objects using the Credential Instance specified by the identifier.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourcesUsingCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the specific Credential Instance</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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 identifier of the specific Credential Instance</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Resources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourcesUsingCredential -id "id_example" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesUsingCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourcesUsingCredential -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesUsingCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/credentials/id/resources/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-VcfOpsPartialUpdateCredential</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPartialUpdateCredential</command:noun> <maml:description> <maml:para>Partial update an existing Credential Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Partial update an existing Credential Instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPartialUpdateCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>The Credential Instance information to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Credential</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Credential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>The Credential Instance information to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Credential</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Credential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Credential = Initialize-VcfOpsCredential -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" -Fields $NameValue -Editable $false Invoke-VcfOpsPartialUpdateCredential -credential $credential </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPartialUpdateCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Credential = Initialize-VcfOpsCredential -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" Invoke-VcfOpsPartialUpdateCredential -credential $credential </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPartialUpdateCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/credentials/patch//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscredential</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-VcfOpsUpdateCredential</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateCredential</command:noun> <maml:description> <maml:para>Update an existing Credential Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an existing Credential Instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>The Credential Instance information to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Credential</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Credential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>The Credential Instance information to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Credential</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Credential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Credential = Initialize-VcfOpsCredential -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" -Fields $NameValue -Editable $false Invoke-VcfOpsUpdateCredential -credential $credential </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateCredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Credential = Initialize-VcfOpsCredential -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" Invoke-VcfOpsUpdateCredential -credential $credential </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateCredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/credentials/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscredential</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-VcfOpsGetGlobalSettingMetadata</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetGlobalSettingMetadata</command:noun> <maml:description> <maml:para>Get global settings metadata</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>Find all the name-key mappings here: </b><br><br>Action History - ACTION_RETENTION_IN_DAYS,<br>Deleted Objects - DELETED_OBJECTS_RETENTION_IN_HOURS, <br>Deletion Scheduling Interval - DELETION_SCHEDULING_INTERVAL_IN_HOURS, <br>Object History - OBJECT_HISTORY_RETENTION_IN_DAYS, <br>Generated Reports Retention - GENERATED_REPORTS_RETENTION_TIME_IN_MONTHS, <br>Session Timeout - SESSION_TIMEOUT_IN_MINUTES, <br>Symptoms/Alerts - CANCELLED_ALERTS_SYMPTOMS_RETENTION_TIME_IN_DAYS, <br>Time Series Data Retention - TIME_SERIES_DATA_RETENTION_IN_MONTHS, <br>Additional Time Series Retention - ROLLUP_TIME_SERIES_DATA_RETENTION_IN_MONTHS, <br>Deleted Users - DELETED_USERS_RETENTION_IN_DAYS, <br>External Event Based Active Symptoms - OUTDATED_EVENT_BASED_SYMPTOMS_CANCELING_ENABLED, <br>External Event Based Active Symptoms - ACTIVE_EVENT_BASED_SYMPTOMS_RETENTION_TIME_IN_DAYS, <br>Dynamic Threshold Calculation - DYNAMIC_THRESHOLDING_UPDATE_TIME_IN_MINUTES, <br>Cost Calculation - COST_CALCULATION_TIME_IN_MINUTES, <br><b>Deprecated from VMware Aria Operations 8.14:</b> Customer Experience Improvement Program - TELEMETRY_ENABLED, <br>Allow vCenter users to log in to individual vCenters from VMware Cloud Foundation Operations - VC_USER_LOGIN_TO_INDIVIDUAL_VC_ALLOWED, <br>Allow vCenter users to log into VMware Cloud Foundation Operations from vCenter clients - VC_USER_LOGIN_FROM_VC_WEBUI_ALLOWED, <br>Allow vCenter users to log in to all vCenters from VMware Cloud Foundation Operations - VC_USER_LOGIN_TO_ALL_VC_ALLOWED, <br>System access URL - BASE_URL, <br>Automated Actions - AUTOMATED_ACTIONS_ENABLED, <br>Enable Standard Certification Validation - ENABLE_CERTIFICATE_VALIDATION_STANDARD_WAY, <br>Concurrent UI login sessions - ALLOW_CONCURRENT_LOGIN_SESSIONS, <br>Allow non-imported vIDM user access - ALLOW_NON_IMPORTED_VIDM_USERS_ACCESS, <br>Dynamic Threshold Calculation - DYNAMIC_THRESHOLDING_ENABLED, <br>Cost Calculation - COST_CALCULATION_ENABLED, <br>Deleted Objects - DELETED_OBJECTS_RETENTION_IN_HOURS_EXPANSION, <br>Generated Reports Retention - GENERATED_REPORTS_RETENTION_ENABLED, <br>Docker image default registry URL - DOCKER_IMAGE_REGISTRY_URL, <br>Tag Based Pricing Metrics - PRICING_TAG_DETAILED_METRICS, <br>Tag based Costing Metrics - COSTING_TAG_DETAILED_METRICS, <br>Cluster Utilization Ceiling Factor - CLUSTER_UTILIZATION_ROUND_OFF, <br>Generated Reports Retention - GENERATED_REPORTS_RETENTION_TIME_IN_DAYS, <br>Threshold For Adapters Certificate Expiration Alert - CERTIFICATE_ALARM_DAYS, <br>Show Cost Savings - SHOW_COST_SAVINGS_RECLAMATION_SETTING, <br>Include Powered off VMs for Reclamation (flag) - RECLAIM_POWERED_OFF_VMS_ENABLED, <br>Include Powered off VMs for Reclamation (days) - RECLAIM_POWERED_OFF_VMS_DAYS, <br>Include Idle VMs for Reclamation - RECLAIM_IDLE_VMS_ENABLED, <br>Minimum number of days that VM has been idle for - RECLAIM_IDLE_VMS_DAYS, <br>Exclude VM provisioned in last - EXCLUDE_IDLE_VMS_PROVISIONED_IN_LAST_DAYS, <br>VM Idleness Criteria (MHz) - IDLENESS_INDICATOR_THRESHOLD_MHZ, <br>VM Idleness Criteria (%) - IDLENESS_INDICATOR_THRESHOLD_PERCENT, <br>Include Snapshots for Reclamation (flag) - RECLAIM_SNAPSHOTS_ENABLED, <br>Include Snapshots for Reclamation (days) - RECLAIM_SNAPSHOTS_DAYS, <br>Include Orphaned Disks for Reclamation (flag) - RECLAIM_ORPHANED_DISKS_ENABLED, <br>Include Orphaned Disks for Reclamation (days) - RECLAIM_ORPHANED_DISKS_DAYS, <br>Orphaned Disks Collection Time - ORPHANED_VMDK_COLLECTION_TIME_IN_MINUTES, <br>Near Real-Time Monitoring Data Retention - NEAR_REAL_TIME_OBJECT_HISTORY_RETENTION, <br>Credential Ownership Enforcement - ACTIVATE_CREDENTIAL_OWNERSHIP.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetGlobalSettingMetadata</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.GlobalSettingsProperties</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetGlobalSettingMetadata </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetGlobalSettingMetadata with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetGlobalSettingMetadata </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetGlobalSettingMetadata with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/deployment/config/globalsettings/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-VcfOpsGetGlobalSettingValue</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetGlobalSettingValue</command:noun> <maml:description> <maml:para>Get global setting value for the requested key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The deprecation info and all key-name mappings can be found in the <i>/api/deployment/config/globalsettings/metadata</i> API's description.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetGlobalSettingValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The global setting 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>Key</maml:name> <maml:Description> <maml:para>The global setting 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>VMware.Bindings.Vcf.Ops.Model.Entry</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetGlobalSettingValue -key "key_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetGlobalSettingValue with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetGlobalSettingValue -key "key_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetGlobalSettingValue with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/deployment/config/globalsettings/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-VcfOpsGetGlobalSettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetGlobalSettings</command:noun> <maml:description> <maml:para>Get all global setting values</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The deprecation info and all key-name mappings can be found in the <i>/api/deployment/config/globalsettings/metadata</i> API's description.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetGlobalSettings</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Entries</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetGlobalSettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetGlobalSettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetGlobalSettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetGlobalSettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/deployment/config/globalsettings/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-VcfOpsGetNodeStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetNodeStatus</command:noun> <maml:description> <maml:para>Get the status of the node</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The status is ONLINE, if all the services are running and responsive, else status is OFFLINE.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetNodeStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Services</maml:name> <maml:Description> <maml:para>Optional set of services to get the aggregated statuses of the node (with empty set the statuses of all services will be aggregated)</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>Services</maml:name> <maml:Description> <maml:para>Optional set of services to get the aggregated statuses of the node (with empty set the statuses of all services will be aggregated)</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>VMware.Bindings.Vcf.Ops.Model.NodeStatus</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetNodeStatus -services "Myservices" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNodeStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetNodeStatus </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNodeStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/deployment/node/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-VcfOpsGetServiceInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetServiceInfo</command:noun> <maml:description> <maml:para>Get information about a specific Service that is part of the VMware Cloud Foundation Operations stack</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The information returned includes the Health of the Service, uptime, start time of the service and etc.<br>Specifically the Health of the Service is 'OK', when the Service is running and responsive, otherwise it is 'Error'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetServiceInfo</maml:name> <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 Service</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>The name of the Service</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Service</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetServiceInfo -name "UI" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServiceInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetServiceInfo -name "UI" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServiceInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/deployment/node/services/name/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-VcfOpsGetServicesInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetServicesInfo</command:noun> <maml:description> <maml:para>Get the health of all Services</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The information returned includes the Health of the Service, uptime, when the service was started and etc.<br>Specifically the Health of the Service is 'OK', when the Service is running and responsive, otherwise it is 'Error'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetServicesInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Services</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetServicesInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServicesInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetServicesInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetServicesInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/deployment/node/services/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-VcfOpsManageDT</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsManageDT</command:noun> <maml:description> <maml:para>Manages a specific run of Dynamic Threshold (DT) Computation in a VMware Cloud Foundation Operations Cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Currently one can Start or Stop a DT Run.<br><b>Sample URI:</b><br><code>PUT /api/deployment/cluster/dt?action=start</code><br><code>PUT /api/deployment/cluster/dt?action=stop</code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsManageDT</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Action</maml:name> <maml:Description> <maml:para>The type of action that one needs to perform - can be either \"start\" or \"stop\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Action</maml:name> <maml:Description> <maml:para>The type of action that one needs to perform - can be either \"start\" or \"stop\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsManageDT -action "action_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsManageDT with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsManageDT -action "action_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsManageDT with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/deployment/cluster/dt/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-VcfOpsUpdateGlobalSettingValue</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateGlobalSettingValue</command:noun> <maml:description> <maml:para>Update global setting value for specified key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The deprecation info and all key-name mappings can be found in the <i>/api/deployment/config/globalsettings/metadata</i> API's description.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateGlobalSettingValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The global setting 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>Value</maml:name> <maml:Description> <maml:para>The global setting 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The global setting 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>Value</maml:name> <maml:Description> <maml:para>The global setting 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>Invoke-VcfOpsUpdateGlobalSettingValue -key "key_example" -value "value_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateGlobalSettingValue with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUpdateGlobalSettingValue -key "key_example" -value "value_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateGlobalSettingValue with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/deployment/config/globalsettings/key/value/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-VcfOpsPushEvent</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPushEvent</command:noun> <maml:description> <maml:para>Push a single Event into the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Push a single Event into the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPushEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Event</maml:name> <maml:Description> <maml:para>The event object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Event</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Event</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Event</maml:name> <maml:Description> <maml:para>The event object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Event</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Event</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Event = Initialize-VcfOpsEvent -EventType "CHANGE" -ResourceId "MyResourceId" -StartTimeUTC 0 -CancelTimeUTC 0 -Message "MyMessage" -Severity "UNKNOWN" -Key "MyKey" -HtType "EQUAL" -DiagnosticSubType "HEALTH" -NotificationSubType "LOG" -Value 0 -KeyIndicator $false -ManagedExternally $false Invoke-VcfOpsPushEvent -_Event $_Event </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPushEvent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Event = Initialize-VcfOpsEvent -EventType "CHANGE" -ResourceId "MyResourceId" -Message "MyMessage" Invoke-VcfOpsPushEvent -_Event $_Event </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPushEvent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/events/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsEvent</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-VcfOpsPushEventByAdapterKindKey</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPushEventByAdapterKindKey</command:noun> <maml:description> <maml:para>Push a single Event into the system with associating an adapter kind as the event source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the adapter kind specified is not present in the system, it will be created dynamically. However, <br>if the adapter kind specified does already exist, then it must be of <i>OPENAPI</i> adapter kind type.<br>Also the API sanitizes the Push Adapter Kind key by removing invalid characters (e.g.: Embedded HTML & JS)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPushEventByAdapterKindKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind key of the adapter 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>_Event</maml:name> <maml:Description> <maml:para>The event object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Event</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Event</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind key of the adapter 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>_Event</maml:name> <maml:Description> <maml:para>The event object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Event</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Event</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Event = Initialize-VcfOpsEvent -EventType "CHANGE" -ResourceId "MyResourceId" -StartTimeUTC 0 -CancelTimeUTC 0 -Message "MyMessage" -Severity "UNKNOWN" -Key "MyKey" -HtType "EQUAL" -DiagnosticSubType "HEALTH" -NotificationSubType "LOG" -Value 0 -KeyIndicator $false -ManagedExternally $false Invoke-VcfOpsPushEventByAdapterKindKey -adapterKind "adapterKind_example" -_Event $_Event </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPushEventByAdapterKindKey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Event = Initialize-VcfOpsEvent -EventType "CHANGE" -ResourceId "MyResourceId" -Message "MyMessage" Invoke-VcfOpsPushEventByAdapterKindKey -adapterKind "adapterKind_example" -_Event $_Event </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPushEventByAdapterKindKey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/events/adapterkinds/adapterKind/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsEvent</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-VcfOpsPushEvents</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPushEvents</command:noun> <maml:description> <maml:para>Push one or more Events into the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Push one or more Events into the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPushEvents</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Events</maml:name> <maml:Description> <maml:para>The list of events</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Events</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Events</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Events</maml:name> <maml:Description> <maml:para>The list of events</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Events</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Events</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Event = Initialize-VcfOpsEvent -EventType "CHANGE" -ResourceId "MyResourceId" -StartTimeUTC 0 -CancelTimeUTC 0 -Message "MyMessage" -Severity "UNKNOWN" -Key "MyKey" -HtType "EQUAL" -DiagnosticSubType "HEALTH" -NotificationSubType "LOG" -Value 0 -KeyIndicator $false -ManagedExternally $false $Events = Initialize-VcfOpsEvents -Event $Event Invoke-VcfOpsPushEvents -events $events </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPushEvents with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Events = Initialize-VcfOpsEvents Invoke-VcfOpsPushEvents -events $events </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPushEvents with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/events/bulk/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsevents</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-VcfOpsPushEventsByAdapterKindKey</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPushEventsByAdapterKindKey</command:noun> <maml:description> <maml:para>Push one or more Events into the system with associating an adapter kind as the event source</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the adapter kind specified is not present in the system, it will be created dynamically. However, <br>if the adapter kind specified does already exist, then it must be of <i>OPENAPI</i> adapter kind type.<br>Also the API sanitizes the Push Adapter Kind key by removing invalid characters (e.g.: Embedded HTML & JS)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPushEventsByAdapterKindKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind key of the adapter 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>Events</maml:name> <maml:Description> <maml:para>The list of events</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Events</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Events</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind key of the adapter 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>Events</maml:name> <maml:Description> <maml:para>The list of events</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Events</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Events</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Event = Initialize-VcfOpsEvent -EventType "CHANGE" -ResourceId "MyResourceId" -StartTimeUTC 0 -CancelTimeUTC 0 -Message "MyMessage" -Severity "UNKNOWN" -Key "MyKey" -HtType "EQUAL" -DiagnosticSubType "HEALTH" -NotificationSubType "LOG" -Value 0 -KeyIndicator $false -ManagedExternally $false $Events = Initialize-VcfOpsEvents -Event $Event Invoke-VcfOpsPushEventsByAdapterKindKey -adapterKind "adapterKind_example" -events $events </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPushEventsByAdapterKindKey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Events = Initialize-VcfOpsEvents Invoke-VcfOpsPushEventsByAdapterKindKey -adapterKind "adapterKind_example" -events $events </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPushEventsByAdapterKindKey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/events/bulk/adapterkinds/adapterKind/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsevents</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-VcfOpsCreateVCFIntegration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateVCFIntegration</command:noun> <maml:description> <maml:para>Create VCF integration with provided parameters. vCenter,vSAN and NSXT adapters for domains, will be created and configured automatically</maml:para> </maml:description> </command:details> <maml:description> <maml:para>vCenter,vSAN and NSXT adapter instances will be generated, upon VCF integration creation, but service discovery is still needed to be enabled manually</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateVCFIntegration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VCFIntegration</maml:name> <maml:Description> <maml:para>The VCF integration creation request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceManagementOwnership</maml:name> <maml:Description> <maml:para>Override existing VCF management ownership</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Create VCF even if connection test fails</maml:para> </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>VCFIntegration</maml:name> <maml:Description> <maml:para>The VCF integration creation request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceManagementOwnership</maml:name> <maml:Description> <maml:para>Override existing VCF management ownership</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Create VCF even if connection test fails</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $VCFIntegration = Initialize-VcfOpsVCFIntegration -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -ResourceIdentifiers $NameValue -Certificates $Certificate -CredentialInstanceId "MyCredentialInstanceId" Invoke-VcfOpsCreateVCFIntegration -vCFIntegration $vCFIntegration -forceManagementOwnership $false -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateVCFIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VCFIntegration = Initialize-VcfOpsVCFIntegration Invoke-VcfOpsCreateVCFIntegration -vCFIntegration $vCFIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateVCFIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsVCFIntegration</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-VcfOpsCreateVcenterIntegration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateVcenterIntegration</command:noun> <maml:description> <maml:para>Create a vCenter integration, with vSAN and Service Discovery configs</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Instances are generated for not just the vCenter adapter but also for vSAN and Service Discovery adapters. If configurations for vSAN or Service Discovery are not provided, the corresponding adapters will not be created.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateVcenterIntegration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterIntegration</maml:name> <maml:Description> <maml:para>The vCenter integration creation request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> <maml: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>Proceed with vCenter integration creation even if connection is not 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceManagementOwnership</maml:name> <maml:Description> <maml:para>Override existing VC management ownership</maml:para> </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>VcenterIntegration</maml:name> <maml:Description> <maml:para>The vCenter integration creation request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> <maml: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>Proceed with vCenter integration creation even if connection is not 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForceManagementOwnership</maml:name> <maml:Description> <maml:para>Override existing VC management ownership</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $VcenterIntegration = Initialize-VcfOpsVcenterIntegration -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -ResourceIdentifiers $NameValue -Certificates $Certificate -CredentialInstanceId "MyCredentialInstanceId" Invoke-VcfOpsCreateVcenterIntegration -vcenterIntegration $vcenterIntegration -force $false -forceManagementOwnership $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateVcenterIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VcenterIntegration = Initialize-VcfOpsVcenterIntegration Invoke-VcfOpsCreateVcenterIntegration -vcenterIntegration $vcenterIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateVcenterIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcenters/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsVcenterIntegration</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-VcfOpsDeleteVcenterIntegration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteVcenterIntegration</command:noun> <maml:description> <maml:para>Delete vcenter integration by provided id</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> Deletion is <em>not synchronous. </em> As a result, the delete operation may not happen immediately. It is recommended to query back the system with the identifier and ensure that the system returns a 404 error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteVcenterIntegration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>UUID of integration, which need to be deleted</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>DeleteResources</maml:name> <maml:Description> <maml:para>If set to true, resources discovered by this integration will be deleted as well.</maml:para> </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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeleteChildResources</maml:name> <maml:Description> <maml:para>If set to true, child adapter instances will be deleted as well.</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Force delete, particularly unregister integration ownership if owned by this Ops</maml:para> </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>IntegrationId</maml:name> <maml:Description> <maml:para>UUID of integration, which need to be deleted</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>DeleteResources</maml:name> <maml:Description> <maml:para>If set to true, resources discovered by this integration will be deleted as well.</maml:para> </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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeleteChildResources</maml:name> <maml:Description> <maml:para>If set to true, child adapter instances will be deleted as well.</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Force delete, particularly unregister integration ownership if owned by this Ops</maml:para> </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-VcfOpsDeleteVcenterIntegration -integrationId "integrationId_example" -deleteResources $false -deleteChildResources $false -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteVcenterIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteVcenterIntegration -integrationId "integrationId_example" -deleteResources $false -deleteChildResources $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteVcenterIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcenters/integrationId/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-VcfOpsDeleteVcfDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteVcfDomain</command:noun> <maml:description> <maml:para>Delete domain by provided id</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> Deletion is <em>not synchronous. </em> As a result, the delete operation may not happen immediately. It is recommended to query back the system with the identifier and ensure that the system returns a 404 error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteVcfDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of integration, domain of which need to be deleted, in UUID format</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>DomainId</maml:name> <maml:Description> <maml:para>The identifier of the VCF's domain in UUID format.</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>DeleteResources</maml:name> <maml:Description> <maml:para>If set to true, resources discovered by this domain will be deleted as well.</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Force delete, particularly unregister domain ownership if owned by this Ops</maml:para> </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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of integration, domain of which need to be deleted, in UUID format</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>DomainId</maml:name> <maml:Description> <maml:para>The identifier of the VCF's domain in UUID format.</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>DeleteResources</maml:name> <maml:Description> <maml:para>If set to true, resources discovered by this domain will be deleted as well.</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Force delete, particularly unregister domain ownership if owned by this Ops</maml:para> </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-VcfOpsDeleteVcfDomain -integrationId "integrationId_example" -domainId "domainId_example" -deleteResources $false -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteVcfDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteVcfDomain -integrationId "integrationId_example" -domainId "domainId_example" -deleteResources $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteVcfDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/integrationId/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-VcfOpsDeleteVcfIntegration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteVcfIntegration</command:noun> <maml:description> <maml:para>Delete integration by provided id</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> Deletion is <em>not synchronous. </em> As a result, the delete operation may not happen immediately. It is recommended to query back the system with the identifier and ensure that the system returns a 404 error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteVcfIntegration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>UUID of integration, which need to be deleted</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>DeleteResources</maml:name> <maml:Description> <maml:para>If set to true, resources discovered by this integration will be deleted as well.</maml:para> </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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeleteChildResources</maml:name> <maml:Description> <maml:para>If set to true, child domains and adapter instances will be deleted as well.</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Force delete, particularly unregister integration ownership if owned by this Ops</maml:para> </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>IntegrationId</maml:name> <maml:Description> <maml:para>UUID of integration, which need to be deleted</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>DeleteResources</maml:name> <maml:Description> <maml:para>If set to true, resources discovered by this integration will be deleted as well.</maml:para> </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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeleteChildResources</maml:name> <maml:Description> <maml:para>If set to true, child domains and adapter instances will be deleted as well.</maml:para> </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>Force</maml:name> <maml:Description> <maml:para>Force delete, particularly unregister integration ownership if owned by this Ops</maml:para> </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-VcfOpsDeleteVcfIntegration -integrationId "integrationId_example" -deleteResources $false -deleteChildResources $false -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteVcfIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteVcfIntegration -integrationId "integrationId_example" -deleteResources $false -deleteChildResources $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteVcfIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/integrationId/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-VcfOpsGetDomainDetailsById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetDomainDetailsById</command:noun> <maml:description> <maml:para>Get VCF domain by provided VCF and domain ids</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetDomainDetailsById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>DomainId</maml:name> <maml:Description> <maml:para>The identifier of the VCF's domain in UUID format.</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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>DomainId</maml:name> <maml:Description> <maml:para>The identifier of the VCF's domain in UUID format.</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>VMware.Bindings.Vcf.Ops.Model.VCFDomainDetails</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetDomainDetailsById -integrationId "integrationId_example" -domainId "domainId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetDomainDetailsById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetDomainDetailsById -integrationId "integrationId_example" -domainId "domainId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetDomainDetailsById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/integrationId/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-VcfOpsGetDomainSummary</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetDomainSummary</command:noun> <maml:description> <maml:para>Get all VCF domains summary for VCF by provided 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-VcfOpsGetDomainSummary</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>VMware.Bindings.Vcf.Ops.Model.VCFDomainSummaries</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetDomainSummary -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetDomainSummary with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetDomainSummary -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetDomainSummary with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/integrationId/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-VcfOpsGetVCFIntegrationById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetVCFIntegrationById</command:noun> <maml:description> <maml:para>Get VCF integration, by specified 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-VcfOpsGetVCFIntegrationById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetVCFIntegrationById -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetVCFIntegrationById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetVCFIntegrationById -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetVCFIntegrationById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/integrationId/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-VcfOpsGetVcenterIntegrationById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetVcenterIntegrationById</command:noun> <maml:description> <maml:para>Get vCenter integration, with vSAN and Service Discovery configs</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetVcenterIntegrationById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the vCenter integration in UUID format.</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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the vCenter integration in UUID format.</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>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetVcenterIntegrationById -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetVcenterIntegrationById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetVcenterIntegrationById -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetVcenterIntegrationById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcenters/integrationId/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-VcfOpsRegisterVC</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsRegisterVC</command:noun> <maml:description> <maml:para>Register vc with provided credentials, and id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If force parameter is passed as true, in case if vc is already registered, registration will be overwritten.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsRegisterVC</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the vCenter integration in UUID format.</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>Force</maml:name> <maml:Description> <maml:para>Force override existing VC management ownership</maml:para> </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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the vCenter integration in UUID format.</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>Force</maml:name> <maml:Description> <maml:para>Force override existing VC management ownership</maml:para> </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-VcfOpsRegisterVC -integrationId "integrationId_example" -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRegisterVC with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsRegisterVC -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRegisterVC with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcenters/integrationId/register/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-VcfOpsRegisterVCF</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsRegisterVCF</command:noun> <maml:description> <maml:para>Register vcf with provided id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If force parameter is passed as true, in case if vcf is already registered, registration will be overwritten. <b>NOTE:<b> The registration of some of the VCs under the VCF may fail because of different issues, e.g. connection issue. In such cases response will be returned with http 200 status code, however the failed resources id's will be reported in the response body. Please check the status field of the response after executing this API, in order to make sure that the operation has fully succeeded.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsRegisterVCF</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>Force</maml:name> <maml:Description> <maml:para>Force override existing vcf management ownership</maml:para> </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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>Force</maml:name> <maml:Description> <maml:para>Force override existing vcf management ownership</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.VcfRegistrationResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsRegisterVCF -integrationId "integrationId_example" -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRegisterVCF with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsRegisterVCF -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsRegisterVCF with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/integrationId/register/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-VcfOpsTestDomain</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsTestDomain</command:noun> <maml:description> <maml:para>Test VCF domain, by provided domain update model, VCF id and domain id</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> This operation will only work for configured domains.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsTestDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>DomainId</maml:name> <maml:Description> <maml:para>The identifier of the VCF's domain in UUID format.</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>VCFDomain</maml:name> <maml:Description> <maml:para>The VCF domain test request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFDomain</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFDomain</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>DomainId</maml:name> <maml:Description> <maml:para>The identifier of the VCF's domain in UUID format.</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>VCFDomain</maml:name> <maml:Description> <maml:para>The VCF domain test request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFDomain</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFDomain</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFDomain</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VCFDomainVcenter = Initialize-VcfOpsVCFDomainVcenter $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $NSXTIntegration = Initialize-VcfOpsNSXTIntegration -Url "MyUrl" -Certificates $Certificate -Enabled $false -Id "MyId" -CredentialId "MyCredentialId" -ServiceCredentialsUsed $false $VCFDomain = Initialize-VcfOpsVCFDomain -VcfDomainVcenter $VCFDomainVcenter -NsxtIntegration $NSXTIntegration Invoke-VcfOpsTestDomain -integrationId "integrationId_example" -domainId "domainId_example" -vCFDomain $vCFDomain </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VCFDomain = Initialize-VcfOpsVCFDomain Invoke-VcfOpsTestDomain -integrationId "integrationId_example" -domainId "domainId_example" -vCFDomain $vCFDomain </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/integrationId/domains/domainId/testConnection/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsVCFDomain</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-VcfOpsTestVCFIntegration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsTestVCFIntegration</command:noun> <maml:description> <maml:para>Test provided VCF integration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In case if certificate is needed, will return untrusted certificate for acceptance in response</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsTestVCFIntegration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VCFIntegration</maml:name> <maml:Description> <maml:para>The VCF integration test request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VCFIntegration</maml:name> <maml:Description> <maml:para>The VCF integration test request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $VCFIntegration = Initialize-VcfOpsVCFIntegration -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -ResourceIdentifiers $NameValue -Certificates $Certificate -CredentialInstanceId "MyCredentialInstanceId" Invoke-VcfOpsTestVCFIntegration -vCFIntegration $vCFIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestVCFIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VCFIntegration = Initialize-VcfOpsVCFIntegration Invoke-VcfOpsTestVCFIntegration -vCFIntegration $vCFIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestVCFIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/testConnection/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsVCFIntegration</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-VcfOpsTestVcenterIntegration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsTestVcenterIntegration</command:noun> <maml:description> <maml:para>Test provided vCenter integration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In case if certificate is needed, will return untrusted certificate for acceptance in response</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsTestVcenterIntegration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterIntegration</maml:name> <maml:Description> <maml:para>The vCenter integration test request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterIntegration</maml:name> <maml:Description> <maml:para>The vCenter integration test request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $VcenterIntegration = Initialize-VcfOpsVcenterIntegration -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -ResourceIdentifiers $NameValue -Certificates $Certificate -CredentialInstanceId "MyCredentialInstanceId" Invoke-VcfOpsTestVcenterIntegration -vcenterIntegration $vcenterIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestVcenterIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VcenterIntegration = Initialize-VcfOpsVcenterIntegration Invoke-VcfOpsTestVcenterIntegration -vcenterIntegration $vcenterIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsTestVcenterIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcenters/testConnection/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsVcenterIntegration</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-VcfOpsUnregisterVC</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUnregisterVC</command:noun> <maml:description> <maml:para>Unregister vc with provided credentials, and 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-VcfOpsUnregisterVC</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the vCenter integration in UUID format.</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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the vCenter integration in UUID format.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsUnregisterVC -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnregisterVC with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUnregisterVC -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnregisterVC with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcenters/integrationId/unregister/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-VcfOpsUnregisterVCF</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUnregisterVCF</command:noun> <maml:description> <maml:para>Unregister vcf with provided id</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:<b> The un-registration of some of the VCs under the VCF may fail because of different issues, e.g. connection issue. In such cases response will be returned with http 200 status code, however the failed resources id's will be reported in the response body. Please check the status field of the response after executing this API, in order to make sure that the operation has fully succeeded.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUnregisterVCF</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>VMware.Bindings.Vcf.Ops.Model.VcfRegistrationResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsUnregisterVCF -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnregisterVCF with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUnregisterVCF -integrationId "integrationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnregisterVCF with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/integrationId/unregister/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-VcfOpsUpdateDomainDetails</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateDomainDetails</command:noun> <maml:description> <maml:para>Update VCF domain, by provided domain model, and VCF id</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> This operation will only work for configured domains.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateDomainDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>DomainId</maml:name> <maml:Description> <maml:para>The identifier of the VCF's domain in UUID format.</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>VCFDomain</maml:name> <maml:Description> <maml:para>The VCF domain update request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFDomain</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFDomain</maml:name> <maml: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>Update the domain even if connection test fails.</maml:para> </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>IntegrationId</maml:name> <maml:Description> <maml:para>The identifier of the VCF integration in UUID format.</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>DomainId</maml:name> <maml:Description> <maml:para>The identifier of the VCF's domain in UUID format.</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>VCFDomain</maml:name> <maml:Description> <maml:para>The VCF domain update request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFDomain</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFDomain</maml:name> <maml: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>Update the domain even if connection test fails.</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.VCFDomain</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VCFDomainVcenter = Initialize-VcfOpsVCFDomainVcenter $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $NSXTIntegration = Initialize-VcfOpsNSXTIntegration -Url "MyUrl" -Certificates $Certificate -Enabled $false -Id "MyId" -CredentialId "MyCredentialId" -ServiceCredentialsUsed $false $VCFDomain = Initialize-VcfOpsVCFDomain -VcfDomainVcenter $VCFDomainVcenter -NsxtIntegration $NSXTIntegration Invoke-VcfOpsUpdateDomainDetails -integrationId "integrationId_example" -domainId "domainId_example" -vCFDomain $vCFDomain -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateDomainDetails with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VCFDomain = Initialize-VcfOpsVCFDomain Invoke-VcfOpsUpdateDomainDetails -integrationId "integrationId_example" -domainId "domainId_example" -vCFDomain $vCFDomain </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateDomainDetails with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/integrationId/domains/domainId/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsVCFDomain</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-VcfOpsUpdateVCFIntegration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateVCFIntegration</command:noun> <maml:description> <maml:para>Update existing VCF integration with provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateVCFIntegration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VCFIntegration</maml:name> <maml:Description> <maml:para>The VCF integration update request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> <maml: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>Update VCF even if connection test fails</maml:para> </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>VCFIntegration</maml:name> <maml:Description> <maml:para>The VCF integration update request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> <maml: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>Update VCF even if connection test fails</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.VCFIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $VCFIntegration = Initialize-VcfOpsVCFIntegration -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -ResourceIdentifiers $NameValue -Certificates $Certificate -CredentialInstanceId "MyCredentialInstanceId" Invoke-VcfOpsUpdateVCFIntegration -vCFIntegration $vCFIntegration -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateVCFIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VCFIntegration = Initialize-VcfOpsVCFIntegration Invoke-VcfOpsUpdateVCFIntegration -vCFIntegration $vCFIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateVCFIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcf/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsVCFIntegration</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-VcfOpsUpdateVcenterIntegration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateVcenterIntegration</command:noun> <maml:description> <maml:para>Update existing vCenter integration, with vSAN and Service Discovery configs</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Instances are updated for not just the vCenter integration but also for vSAN and Service Discovery adapters. If configurations for vSAN or Service Discovery are not provided, the corresponding adapters will not be updated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateVcenterIntegration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcenterIntegration</maml:name> <maml:Description> <maml:para>The vCenter integration update request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> <maml: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>Proceed with vCenter integration update even if connection is not 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>VcenterIntegration</maml:name> <maml:Description> <maml:para>The vCenter integration update request</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> <maml: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>Proceed with vCenter integration update even if connection is not 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>VMware.Bindings.Vcf.Ops.Model.VcenterIntegration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $VcenterIntegration = Initialize-VcfOpsVcenterIntegration -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -ResourceIdentifiers $NameValue -Certificates $Certificate -CredentialInstanceId "MyCredentialInstanceId" Invoke-VcfOpsUpdateVcenterIntegration -vcenterIntegration $vcenterIntegration -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateVcenterIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VcenterIntegration = Initialize-VcfOpsVcenterIntegration Invoke-VcfOpsUpdateVcenterIntegration -vcenterIntegration $vcenterIntegration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateVcenterIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/integrations/vcenters/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsVcenterIntegration</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-VcfOpsCreateOrUpdateLogConfigurations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateOrUpdateLogConfigurations</command:noun> <maml:description> <maml:para>Change level of the logs</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Change level of the logs</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateOrUpdateLogConfigurations</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Logtype</maml:name> <maml:Description> <maml:para>Log 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>LogConfiguration</maml:name> <maml:Description> <maml:para>The data for log configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.LogConfiguration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LogConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AllowAddingNewSettings</maml:name> <maml:Description> <maml:para>Set this flag to 'true' to add new log classes. The 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>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>Logtype</maml:name> <maml:Description> <maml:para>Log 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>LogConfiguration</maml:name> <maml:Description> <maml:para>The data for log configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.LogConfiguration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LogConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AllowAddingNewSettings</maml:name> <maml:Description> <maml:para>Set this flag to 'true' to add new log classes. The 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>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LogConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LogSettings = Initialize-VcfOpsLogSettings -Name "MyName" -Level "ALL" $LogConfiguration = Initialize-VcfOpsLogConfiguration -RootLoggerLevel "INFO" -MaxLogSize 0 -Settings $LogSettings Invoke-VcfOpsCreateOrUpdateLogConfigurations -logtype "ANALYTICS" -logConfiguration $logConfiguration -allowAddingNewSettings $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateOrUpdateLogConfigurations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LogConfiguration = Initialize-VcfOpsLogConfiguration Invoke-VcfOpsCreateOrUpdateLogConfigurations -logtype "ANALYTICS" -logConfiguration $logConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateOrUpdateLogConfigurations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/logs/configuration/logtype/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpslogconfiguration</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-VcfOpsDeleteLogConfigurationSettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteLogConfigurationSettings</command:noun> <maml:description> <maml:para>Remove the log classes from the log type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove the log classes from the log type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteLogConfigurationSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Logtype</maml:name> <maml:Description> <maml:para>Log 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>StrValues</maml:name> <maml:Description> <maml:para>Log class names to remove</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StrValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StrValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Logtype</maml:name> <maml:Description> <maml:para>Log 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>StrValues</maml:name> <maml:Description> <maml:para>Log class names to remove</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StrValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StrValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StrValues = Initialize-VcfOpsStrValues -Values "MyValues" Invoke-VcfOpsDeleteLogConfigurationSettings -logtype "ANALYTICS" -strValues $strValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteLogConfigurationSettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StrValues = Initialize-VcfOpsStrValues Invoke-VcfOpsDeleteLogConfigurationSettings -logtype "ANALYTICS" -strValues $strValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteLogConfigurationSettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/logs/configuration/logtype/settings/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsstrvalues</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-VcfOpsDisableLogForwarding</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDisableLogForwarding</command:noun> <maml:description> <maml:para>Disable log forwarding</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> While disabling, \"entities\" will be removed from the log forwarding configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDisableLogForwarding</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-VcfOpsDisableLogForwarding </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableLogForwarding with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDisableLogForwarding </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableLogForwarding with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/logs/forwarding/disable/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-VcfOpsEnableLogForwarding</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsEnableLogForwarding</command:noun> <maml:description> <maml:para>Enable log forwarding</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Enables log forwarding and sets the entities to forward the logs from.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsEnableLogForwarding</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Entity</maml:name> <maml:Description> <maml:para>Entities to forward the logs from</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>Entity</maml:name> <maml:Description> <maml:para>Entities to forward the logs from</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-VcfOpsEnableLogForwarding -entity "ANALYTICS" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableLogForwarding with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsEnableLogForwarding -entity "ANALYTICS" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableLogForwarding with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/logs/forwarding/enable/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-VcfOpsGetLogConfigurationsByType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetLogConfigurationsByType</command:noun> <maml:description> <maml:para>Get logs configurations of certain type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get logs configurations of certain type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetLogConfigurationsByType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Logtype</maml:name> <maml:Description> <maml:para>Log 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>Logtype</maml:name> <maml:Description> <maml:para>Log 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>VMware.Bindings.Vcf.Ops.Model.LogConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetLogConfigurationsByType -logtype "ANALYTICS" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLogConfigurationsByType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetLogConfigurationsByType -logtype "ANALYTICS" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLogConfigurationsByType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/logs/configuration/logtype/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-VcfOpsGetLogForwardingConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetLogForwardingConfiguration</command:noun> <maml:description> <maml:para>Get log forwarding configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns log forwarding configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetLogForwardingConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LogForwardingConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetLogForwardingConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLogForwardingConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetLogForwardingConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLogForwardingConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/logs/forwarding/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-VcfOpsUpdateLogForwardingConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateLogForwardingConfiguration</command:noun> <maml:description> <maml:para>Create a new or update an existing log forwarding configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> The \"enabled\" field should not be specified. Log forwarding will be enabled as a result of this API call. To disable log forwarding use \"/api/logforwarding/disable\" API</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateLogForwardingConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LogForwardingConfiguration</maml:name> <maml:Description> <maml:para>The log forwarding configuration data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.LogForwardingConfiguration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LogForwardingConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LogForwardingConfiguration</maml:name> <maml:Description> <maml:para>The log forwarding configuration data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.LogForwardingConfiguration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LogForwardingConfiguration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LogForwardingConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"ANALYTICS"$LogForwardingConfiguration = Initialize-VcfOpsLogForwardingConfiguration -Enabled $false -Entities "ANALYTICS" -Host "MyHost" -Protocol "CFAPI" -Port 0 -UseSSL $false -SslCertPath "MySslCertPath" -Cluster "MyCluster" Invoke-VcfOpsUpdateLogForwardingConfiguration -logForwardingConfiguration $logForwardingConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateLogForwardingConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>"ANALYTICS"$LogForwardingConfiguration = Initialize-VcfOpsLogForwardingConfiguration -Entities "ANALYTICS" -Host "MyHost" -Protocol "CFAPI" -Cluster "MyCluster" Invoke-VcfOpsUpdateLogForwardingConfiguration -logForwardingConfiguration $logForwardingConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateLogForwardingConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/logs/forwarding/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpslogforwardingconfiguration</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-VcfOpsCreateMaintenanceSchedules</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateMaintenanceSchedules</command:noun> <maml:description> <maml:para>Create a maintenance schedule</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can create a particular <i>maintenance schedules</i></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateMaintenanceSchedules</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaintenanceSchedule</maml:name> <maml:Description> <maml:para>The maintenance schedule to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaintenanceSchedule</maml:name> <maml:Description> <maml:para>The maintenance schedule to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"UNKNOWNN""UNKNOWN"$Schedule = Initialize-VcfOpsSchedule -Hour 0 -MinuteOfTheHour 0 -Duration 0 -ScheduleType "UNKNOWN" -Recurrence 0 -DayOfTheMonth 0 -DaysOfTheMonth "MyDaysOfTheMonth" -WeeksOfTheMonth "UNKNOWNN" -DaysOfTheWeek "UNKNOWNN""UNKNOWN" -Month 0 -Months 0 -StartDate "MyStartDate" -ExpirationDate "MyExpirationDate" -TimeZone "MyTimeZone" -ExpireRuns 0 $MaintenanceSchedule = Initialize-VcfOpsMaintenanceSchedule -Id "MyId" -Key "MyKey" -Schedule $Schedule Invoke-VcfOpsCreateMaintenanceSchedules -maintenanceSchedule $maintenanceSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateMaintenanceSchedules with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Schedule = Initialize-VcfOpsSchedule -Hour 0 -MinuteOfTheHour 0 -Duration 0 -ScheduleType "UNKNOWN" $MaintenanceSchedule = Initialize-VcfOpsMaintenanceSchedule -Key "MyKey" -Schedule $Schedule Invoke-VcfOpsCreateMaintenanceSchedules -maintenanceSchedule $maintenanceSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateMaintenanceSchedules with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/maintenanceschedules/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsmaintenanceschedule</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-VcfOpsDeleteMaintenanceSchedules</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteMaintenanceSchedules</command:noun> <maml:description> <maml:para>Delete maintenance schedules with the given identifiers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can delete a particular <i>maintenance schedules</i></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteMaintenanceSchedules</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Maintenance schedule identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Maintenance schedule identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteMaintenanceSchedules -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteMaintenanceSchedules with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteMaintenanceSchedules -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteMaintenanceSchedules with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/maintenanceschedules/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-VcfOpsGetMaintenanceSchedules</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetMaintenanceSchedules</command:noun> <maml:description> <maml:para>Query for all maintenance schedules based on schedule id, schedule name and resource id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can get all <i>maintenance schedules</i> with or without specific parameters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetMaintenanceSchedules</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Maintenance schedule identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Name</maml:name> <maml:Description> <maml:para>Maintenance schedule names or keys</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>ResourceId</maml:name> <maml:Description> <maml:para>List of Object identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>Maintenance schedule identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Name</maml:name> <maml:Description> <maml:para>Maintenance schedule names or keys</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>ResourceId</maml:name> <maml:Description> <maml:para>List of Object identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedules</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetMaintenanceSchedules -id "Myid" -name "Myname" -resourceId "MyresourceId" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetMaintenanceSchedules with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetMaintenanceSchedules </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetMaintenanceSchedules with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/maintenanceschedules/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-VcfOpsUpdateMaintenanceSchedules</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateMaintenanceSchedules</command:noun> <maml:description> <maml:para>Update an existing maintenance schedules</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can update a particular <i>maintenance schedules</i></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateMaintenanceSchedules</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaintenanceSchedule</maml:name> <maml:Description> <maml:para>The maintenance schedules to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaintenanceSchedule</maml:name> <maml:Description> <maml:para>The maintenance schedules to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.MaintenanceSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"UNKNOWNN""UNKNOWN"$Schedule = Initialize-VcfOpsSchedule -Hour 0 -MinuteOfTheHour 0 -Duration 0 -ScheduleType "UNKNOWN" -Recurrence 0 -DayOfTheMonth 0 -DaysOfTheMonth "MyDaysOfTheMonth" -WeeksOfTheMonth "UNKNOWNN" -DaysOfTheWeek "UNKNOWNN""UNKNOWN" -Month 0 -Months 0 -StartDate "MyStartDate" -ExpirationDate "MyExpirationDate" -TimeZone "MyTimeZone" -ExpireRuns 0 $MaintenanceSchedule = Initialize-VcfOpsMaintenanceSchedule -Id "MyId" -Key "MyKey" -Schedule $Schedule Invoke-VcfOpsUpdateMaintenanceSchedules -maintenanceSchedule $maintenanceSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateMaintenanceSchedules with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Schedule = Initialize-VcfOpsSchedule -Hour 0 -MinuteOfTheHour 0 -Duration 0 -ScheduleType "UNKNOWN" $MaintenanceSchedule = Initialize-VcfOpsMaintenanceSchedule -Key "MyKey" -Schedule $Schedule Invoke-VcfOpsUpdateMaintenanceSchedules -maintenanceSchedule $maintenanceSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateMaintenanceSchedules with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/maintenanceschedules/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsmaintenanceschedule</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-VcfOpsCreateNotificationPluginRule</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateNotificationPluginRule</command:noun> <maml:description> <maml:para>Create a new Notification Rule for a Notification Plugin Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Notification Plugin with which the Rule needs to be associated must be specified as part of the request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateNotificationPluginRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationRule</maml:name> <maml:Description> <maml:para>The notification rule that needs to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationRule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationRule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationRule</maml:name> <maml:Description> <maml:para>The notification rule that needs to be created</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationRule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationRule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationRule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"OPEN""NEW""UNKNOWN" $ResourceKindFilter = Initialize-VcfOpsResourceKindFilter -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceFilter = Initialize-VcfOpsResourceFilter -ResourceId "MyResourceId" -MatchResourceIdOnly $false -ChildrenResourceKindFilters "MyChildrenResourceKindFilters" -ChildrenResourceKindKeyFilters $ResourceKindKey -Relationship "PARENT" $AlertTypeFilter = Initialize-VcfOpsAlertTypeFilter -AlertType 0 -AlertSubTypes 0 $StrValues = Initialize-VcfOpsStrValues -Values "MyValues" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" "SUCCEEDED"$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $NotificationRule = Initialize-VcfOpsNotificationRule -Id "MyId" -Name "MyName" -PluginId "MyPluginId" -Enabled $false -TemplateId "MyTemplateId" -AlertControlStates "OPEN" -AlertStatuses "OPEN""NEW" -Criticalities "OPEN""NEW""UNKNOWN" -ResourceKindFilter $ResourceKindFilter -ResourceKindFilters $ResourceKindKey -ResourceFilter $ResourceFilter -ResourceFilters $ResourceFilter -AlertTypeFilters $AlertTypeFilter -AlertDefinitionIdFilters $StrValues -AlertImpactFilters $StrValues -SendHeartbeat $false -Properties $NameValue -CollectorUUId "MyCollectorUUId" -CollectorGroupId "MyCollectorGroupId" -RuleType "ALERT" -ActionStatuses "OPEN""NEW""UNKNOWN" $ResourceKindFilter = Initialize-VcfOpsResourceKindFilter -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceFilter = Initialize-VcfOpsResourceFilter -ResourceId "MyResourceId" -MatchResourceIdOnly $false -ChildrenResourceKindFilters "MyChildrenResourceKindFilters" -ChildrenResourceKindKeyFilters $ResourceKindKey -Relationship "PARENT" $AlertTypeFilter = Initialize-VcfOpsAlertTypeFilter -AlertType 0 -AlertSubTypes 0 $StrValues = Initialize-VcfOpsStrValues -Values "MyValues" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" "SUCCEEDED" -Links $Link Invoke-VcfOpsCreateNotificationPluginRule -notificationRule $notificationRule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateNotificationPluginRule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NotificationRule = Initialize-VcfOpsNotificationRule -Name "MyName" -PluginId "MyPluginId" Invoke-VcfOpsCreateNotificationPluginRule -notificationRule $notificationRule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateNotificationPluginRule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/rules/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsnotificationrule</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-VcfOpsCreateNotificationTemplate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateNotificationTemplate</command:noun> <maml:description> <maml:para>Create a new notification template</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new notification template.<br><b>NOTE:</b> Limit for selected Resource Kinds count is 30.<br><b>NOTE:</b> Limit for selected Stats count is 30.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationTemplate</maml:name> <maml:Description> <maml:para>Notification template as payload</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationTemplate</maml:name> <maml:Description> <maml:para>Notification template as payload</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKeyStats = Initialize-VcfOpsResourceKindKeyStats -ResourceKindKey $ResourceKindKey -Stats "MyStats" $TemplateContentConfig = Initialize-VcfOpsTemplateContentConfig -BaseResourceKindKeyStats $ResourceKindKeyStats -AncestorResourceKindKeys $ResourceKindKeyStats -DescendantResourceKindKeys $ResourceKindKeyStats $OneOfFormattingTemplate = Initialize-VcfOpsOneOfFormattingTemplate $TemplateProperty = Initialize-VcfOpsTemplateProperty -Key "MyKey" -Name "MyName" -Type "STRING" -Description "MyDescription" $NotificationTemplate = Initialize-VcfOpsNotificationTemplate -TemplateId "MyTemplateId" -PluginTypeId "MyPluginTypeId" -Name "MyName" -Description "MyDescription" -LastModifiedBy "MyLastModifiedBy" -LastModifiedOn 0 -ContentConfigs $TemplateContentConfig -FormattingTemplate $OneOfFormattingTemplate -TemplateProperties $TemplateProperty -AttachedRuleCount 0 -Editable $false -TemplateType "ALERT" Invoke-VcfOpsCreateNotificationTemplate -notificationTemplate $notificationTemplate </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateNotificationTemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NotificationTemplate = Initialize-VcfOpsNotificationTemplate -PluginTypeId "MyPluginTypeId" -Name "MyName" Invoke-VcfOpsCreateNotificationTemplate -notificationTemplate $notificationTemplate </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateNotificationTemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/templates/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsnotificationtemplate</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-VcfOpsDeleteNotificationPluginRules</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteNotificationPluginRules</command:noun> <maml:description> <maml:para>Delete a specific existing Notification Rule associated with a Notification Plugin Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using this method, you can delete a particular <i>notification plugin rule</i></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteNotificationPluginRules</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Notification Rule Identifier</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>The Notification Rule Identifier</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteNotificationPluginRules -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteNotificationPluginRules with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteNotificationPluginRules -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteNotificationPluginRules with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/rules/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-VcfOpsDeleteNotificationTemplate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteNotificationTemplate</command:noun> <maml:description> <maml:para>Delete notification template</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete notification template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Notification template 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: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>Notification template 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteNotificationTemplate -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteNotificationTemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteNotificationTemplate -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteNotificationTemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/templates/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-VcfOpsGetAllNotificationRules</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAllNotificationRules</command:noun> <maml:description> <maml:para>Get all the Notification Rules defined in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all the Notification Rules defined in the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAllNotificationRules</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationRules</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAllNotificationRules -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAllNotificationRules with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAllNotificationRules </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAllNotificationRules with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/rules/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-VcfOpsGetNotificationRule</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetNotificationRule</command:noun> <maml:description> <maml:para>Get the Notification Rule for the specified identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Notification Rule for the specified identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetNotificationRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the notification rule</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>The Identifier of the notification rule</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>VMware.Bindings.Vcf.Ops.Model.NotificationRule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetNotificationRule -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNotificationRule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetNotificationRule -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNotificationRule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/rules/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-VcfOpsGetNotificationTemplate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetNotificationTemplate</command:noun> <maml:description> <maml:para>Get notification template</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns notification template for the specified id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Notification template 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: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>Notification template 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetNotificationTemplate -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNotificationTemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetNotificationTemplate -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNotificationTemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/templates/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-VcfOpsGetNotificationTemplates</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetNotificationTemplates</command:noun> <maml:description> <maml:para>Get notification templates matching the search criteria specified</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the search criteria is not satisfied, the API will return all Notification Templates</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetNotificationTemplates</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Template name to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Template description to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OutboundMethod</maml:name> <maml:Description> <maml:para>Attached outbound method of template to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ModifiedBy</maml:name> <maml:Description> <maml:para>Template modified user name to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>Template name to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Template description to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OutboundMethod</maml:name> <maml:Description> <maml:para>Attached outbound method of template to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ModifiedBy</maml:name> <maml:Description> <maml:para>Template modified user name to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationTemplates</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetNotificationTemplates -name "name_example" -description "description_example" -outboundMethod "outboundMethod_example" -modifiedBy "modifiedBy_example" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNotificationTemplates with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetNotificationTemplates </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNotificationTemplates with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/templates/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-VcfOpsUpdateNotificationPluginRule</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateNotificationPluginRule</command:noun> <maml:description> <maml:para>Update a specific Notification Rule for a Notification Plugin Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a specific Notification Rule for a Notification Plugin Instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateNotificationPluginRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationRule</maml:name> <maml:Description> <maml:para>The notification rule that needs to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationRule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationRule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationRule</maml:name> <maml:Description> <maml:para>The notification rule that needs to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationRule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationRule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationRule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"OPEN""NEW""UNKNOWN" $ResourceKindFilter = Initialize-VcfOpsResourceKindFilter -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceFilter = Initialize-VcfOpsResourceFilter -ResourceId "MyResourceId" -MatchResourceIdOnly $false -ChildrenResourceKindFilters "MyChildrenResourceKindFilters" -ChildrenResourceKindKeyFilters $ResourceKindKey -Relationship "PARENT" $AlertTypeFilter = Initialize-VcfOpsAlertTypeFilter -AlertType 0 -AlertSubTypes 0 $StrValues = Initialize-VcfOpsStrValues -Values "MyValues" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" "SUCCEEDED"$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $NotificationRule = Initialize-VcfOpsNotificationRule -Id "MyId" -Name "MyName" -PluginId "MyPluginId" -Enabled $false -TemplateId "MyTemplateId" -AlertControlStates "OPEN" -AlertStatuses "OPEN""NEW" -Criticalities "OPEN""NEW""UNKNOWN" -ResourceKindFilter $ResourceKindFilter -ResourceKindFilters $ResourceKindKey -ResourceFilter $ResourceFilter -ResourceFilters $ResourceFilter -AlertTypeFilters $AlertTypeFilter -AlertDefinitionIdFilters $StrValues -AlertImpactFilters $StrValues -SendHeartbeat $false -Properties $NameValue -CollectorUUId "MyCollectorUUId" -CollectorGroupId "MyCollectorGroupId" -RuleType "ALERT" -ActionStatuses "OPEN""NEW""UNKNOWN" $ResourceKindFilter = Initialize-VcfOpsResourceKindFilter -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceFilter = Initialize-VcfOpsResourceFilter -ResourceId "MyResourceId" -MatchResourceIdOnly $false -ChildrenResourceKindFilters "MyChildrenResourceKindFilters" -ChildrenResourceKindKeyFilters $ResourceKindKey -Relationship "PARENT" $AlertTypeFilter = Initialize-VcfOpsAlertTypeFilter -AlertType 0 -AlertSubTypes 0 $StrValues = Initialize-VcfOpsStrValues -Values "MyValues" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" "SUCCEEDED" -Links $Link Invoke-VcfOpsUpdateNotificationPluginRule -notificationRule $notificationRule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateNotificationPluginRule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NotificationRule = Initialize-VcfOpsNotificationRule -Name "MyName" -PluginId "MyPluginId" Invoke-VcfOpsUpdateNotificationPluginRule -notificationRule $notificationRule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateNotificationPluginRule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/rules/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsnotificationrule</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-VcfOpsUpdateNotificationTemplate</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateNotificationTemplate</command:noun> <maml:description> <maml:para>Update an existing notification template</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates an existing notification template.<br><b>NOTE:</b> Limit for selected Resource Kinds count is 30.<br><b>NOTE:</b> Limit for selected Stats count is 30.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationTemplate</maml:name> <maml:Description> <maml:para>Notification template as payload</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationTemplate</maml:name> <maml:Description> <maml:para>Notification template as payload</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKeyStats = Initialize-VcfOpsResourceKindKeyStats -ResourceKindKey $ResourceKindKey -Stats "MyStats" $TemplateContentConfig = Initialize-VcfOpsTemplateContentConfig -BaseResourceKindKeyStats $ResourceKindKeyStats -AncestorResourceKindKeys $ResourceKindKeyStats -DescendantResourceKindKeys $ResourceKindKeyStats $OneOfFormattingTemplate = Initialize-VcfOpsOneOfFormattingTemplate $TemplateProperty = Initialize-VcfOpsTemplateProperty -Key "MyKey" -Name "MyName" -Type "STRING" -Description "MyDescription" $NotificationTemplate = Initialize-VcfOpsNotificationTemplate -TemplateId "MyTemplateId" -PluginTypeId "MyPluginTypeId" -Name "MyName" -Description "MyDescription" -LastModifiedBy "MyLastModifiedBy" -LastModifiedOn 0 -ContentConfigs $TemplateContentConfig -FormattingTemplate $OneOfFormattingTemplate -TemplateProperties $TemplateProperty -AttachedRuleCount 0 -Editable $false -TemplateType "ALERT" Invoke-VcfOpsUpdateNotificationTemplate -notificationTemplate $notificationTemplate </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateNotificationTemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NotificationTemplate = Initialize-VcfOpsNotificationTemplate -PluginTypeId "MyPluginTypeId" -Name "MyName" Invoke-VcfOpsUpdateNotificationTemplate -notificationTemplate $notificationTemplate </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateNotificationTemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/notifications/templates/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsnotificationtemplate</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-VcfOpsDeletePlacementConfiguration</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeletePlacementConfiguration</command:noun> <maml:description> <maml:para>Turn off placement settings on datacenter</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE:</b> The current settings will be removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeletePlacementConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeletePlacementConfiguration -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeletePlacementConfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeletePlacementConfiguration -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeletePlacementConfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/dataCenterId/settings/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-VcfOpsDisableAutomation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDisableAutomation</command:noun> <maml:description> <maml:para>Turning off automation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If you disable automation, the system will still look for optimization opportunities. Any actions will now be manual<br><b>NOTE:</b> If you have any scheduled optimizations, they will be re-activated</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDisableAutomation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDisableAutomation -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableAutomation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDisableAutomation -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableAutomation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/dataCenterId/automation/disable/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-VcfOpsDisableCrossDCMove</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDisableCrossDCMove</command:noun> <maml:description> <maml:para>Disable cluster-level optimization across datacenter boundaries in a vCenter</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disable cluster-level optimization across datacenter boundaries in a vCenter.<br/><b>NOTE:</b> This API is only applicable for custom datacenters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDisableCrossDCMove</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDisableCrossDCMove -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableCrossDCMove with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDisableCrossDCMove -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDisableCrossDCMove with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/dataCenterId/crossdcmove/disable/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-VcfOpsEnableAutomation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsEnableAutomation</command:noun> <maml:description> <maml:para>Turning on automation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Enabling automation will allow the system to optimize your datacenter by continuously looking for optimization opportunities<br><b>NOTE:</b> Any scheduled optimizations will be deactivated during the time</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsEnableAutomation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsEnableAutomation -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableAutomation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsEnableAutomation -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableAutomation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/dataCenterId/automation/enable/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-VcfOpsEnableCrossDCMove</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsEnableCrossDCMove</command:noun> <maml:description> <maml:para>Enable cluster-level optimization across datacenter boundaries in a vCenter</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If your custom datacenter includes clusters from multiple datacenters within the same vCenter, you can enable cross datacenter move to ensure optimization occurs across datacenter boundaries.<br/><b>NOTE:</b> This API is only applicable for custom datacenters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsEnableCrossDCMove</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsEnableCrossDCMove -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableCrossDCMove with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsEnableCrossDCMove -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsEnableCrossDCMove with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/dataCenterId/crossdcmove/enable/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-VcfOpsGetAutomationStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAutomationStatus</command:noun> <maml:description> <maml:para>Get optimization automation status</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get optimization automation status</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAutomationStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>VMware.Bindings.Vcf.Ops.Model.WorkloadOptimizationAutomationStatus</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAutomationStatus -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAutomationStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAutomationStatus -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAutomationStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/dataCenterId/automation/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-VcfOpsGetCrossDCMoveStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCrossDCMoveStatus</command:noun> <maml:description> <maml:para>Get cross datacenter move allowed status</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get cross datacenter move allowed status.<br/><b>NOTE:</b> This API is only applicable for custom datacenters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCrossDCMoveStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>DataCenterId</maml:name> <maml:Description> <maml:para>ID of the dataCenter</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>VMware.Bindings.Vcf.Ops.Model.CrossDcMoveStatus</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCrossDCMoveStatus -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCrossDCMoveStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCrossDCMoveStatus -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCrossDCMoveStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/dataCenterId/crossdcmove/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-VcfOpsGetPlacementSettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetPlacementSettings</command:noun> <maml:description> <maml:para>Get placement settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>No description available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetPlacementSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataCenterId</maml:name> <maml:Description> <maml:para>Identifier of the dataCenter</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>DataCenterId</maml:name> <maml:Description> <maml:para>Identifier of the dataCenter</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>VMware.Bindings.Vcf.Ops.Model.WorkloadPlacementSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetPlacementSettings -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetPlacementSettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetPlacementSettings -dataCenterId "dataCenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetPlacementSettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/dataCenterId/settings/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-VcfOpsGetWlpHistory</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetWlpHistory</command:noun> <maml:description> <maml:para>Get WLP History.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get WLP History.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetWlpHistory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WlpHistoryQuery</maml:name> <maml:Description> <maml:para>wlpHistoryQuery</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.WlpHistoryQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.WlpHistoryQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WlpHistoryQuery</maml:name> <maml:Description> <maml:para>wlpHistoryQuery</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.WlpHistoryQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.WlpHistoryQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.WlpHistory</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$WlpHistoryQuery = Initialize-VcfOpsWlpHistoryQuery -StartTime 0 -EndTime 0 -ResourceIds "MyResourceIds" Invoke-VcfOpsGetWlpHistory -wlpHistoryQuery $wlpHistoryQuery -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetWlpHistory with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$WlpHistoryQuery = Initialize-VcfOpsWlpHistoryQuery Invoke-VcfOpsGetWlpHistory -wlpHistoryQuery $wlpHistoryQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetWlpHistory with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/history/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpswlphistoryquery</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-VcfOpsSetPlacementSettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSetPlacementSettings</command:noun> <maml:description> <maml:para>Set up your business intent to place VMs based on criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>To set host level placement constraints, VMware Cloud Foundation Operations will automatically create and manage DRS rules. All conflicting user-created DRS rules need to be DEACTIVATED. These include the following:<br><ul><li>VM-VM affinity / anti-affinity</li><br><li>VM-Host affinity / anti-affinity</li><br></ul></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSetPlacementSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataCenterId</maml:name> <maml:Description> <maml:para>Identifier of the dataCenter</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>WorkloadPlacementSettings</maml:name> <maml:Description> <maml:para>Placement settings object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.WorkloadPlacementSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.WorkloadPlacementSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeactivateDRSRules</maml:name> <maml:Description> <maml:para>During HOST_BASED configuration, set this flag to true to deactivate all conflicting user-created DRS rules</maml:para> </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>DataCenterId</maml:name> <maml:Description> <maml:para>Identifier of the dataCenter</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>WorkloadPlacementSettings</maml:name> <maml:Description> <maml:para>Placement settings object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.WorkloadPlacementSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.WorkloadPlacementSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DeactivateDRSRules</maml:name> <maml:Description> <maml:para>During HOST_BASED configuration, set this flag to true to deactivate all conflicting user-created DRS rules</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.WorkloadPlacementSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $TagGroup = Initialize-VcfOpsTagGroup -Name "MyName" -Prioritized $false -ResourceTags $ResourceTag $WorkloadPlacementSettings = Initialize-VcfOpsWorkloadPlacementSettings -TaggingScope "CLUSTER_BASED" -TagGroups $TagGroup -ExcludedClusterTagGroups $TagGroup -ExcludedVmTagGroups $TagGroup -PlacementSettingsEnabled $false -ClusterExclusionEnabled $false -VmExclusionEnabled $false Invoke-VcfOpsSetPlacementSettings -dataCenterId "dataCenterId_example" -workloadPlacementSettings $workloadPlacementSettings -deactivateDRSRules $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetPlacementSettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$WorkloadPlacementSettings = Initialize-VcfOpsWorkloadPlacementSettings Invoke-VcfOpsSetPlacementSettings -dataCenterId "dataCenterId_example" -workloadPlacementSettings $workloadPlacementSettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetPlacementSettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/optimization/workloadplacement/dataCenterId/settings/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsworkloadplacementsettings</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-VcfOpsApplyPolicy</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsApplyPolicy</command:noun> <maml:description> <maml:para>Apply policy to the given groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Applies policy to the given groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsApplyPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyGroups</maml:name> <maml:Description> <maml:para>The Policy object carrying id and name of the policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicyGroups</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyGroups</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyGroups</maml:name> <maml:Description> <maml:para>The Policy object carrying id and name of the policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicyGroups</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyGroups</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PolicyGroups = Initialize-VcfOpsPolicyGroups -Id "MyId" -Groups "MyGroups" Invoke-VcfOpsApplyPolicy -policyGroups $policyGroups </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsApplyPolicy with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PolicyGroups = Initialize-VcfOpsPolicyGroups -Id "MyId" -Groups "MyGroups" Invoke-VcfOpsApplyPolicy -policyGroups $policyGroups </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsApplyPolicy with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/apply/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspolicygroups</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-VcfOpsAssignPolicy</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAssignPolicy</command:noun> <maml:description> <maml:para>Assign policy to the given groups, and objects</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Assigns policy to the given groups, and objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAssignPolicy</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">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>PolicyAssignmentParam</maml:name> <maml:Description> <maml:para>The Policy assignment object carrying ids of groups, ids and depths of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicyAssignmentParam</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyAssignmentParam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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">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>PolicyAssignmentParam</maml:name> <maml:Description> <maml:para>The Policy assignment object carrying ids of groups, ids and depths of resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicyAssignmentParam</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyAssignmentParam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyAssociationsUpdateResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceAssignment = Initialize-VcfOpsResourceAssignment -ResourceId "MyResourceId" -Depth 0 $PolicyAssignmentParam = Initialize-VcfOpsPolicyAssignmentParam -GroupIds "MyGroupIds" -ResourceAssignments $ResourceAssignment Invoke-VcfOpsAssignPolicy -id "id_example" -policyAssignmentParam $policyAssignmentParam </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignPolicy with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PolicyAssignmentParam = Initialize-VcfOpsPolicyAssignmentParam Invoke-VcfOpsAssignPolicy -id "id_example" -policyAssignmentParam $policyAssignmentParam </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAssignPolicy with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/id/assign/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspolicyassignmentparam</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-VcfOpsCreatePolicy</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreatePolicy</command:noun> <maml:description> <maml:para>Create a new policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreatePolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Policy</maml:name> <maml:Description> <maml:para>The Policy object which can be used to create the policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Policy</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Policy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 Policy object which can be used to create the policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Policy</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Policy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Policy</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Policy = Initialize-VcfOpsPolicy -Name "MyName" -Description "MyDescription" -ParentPolicy "MyParentPolicy" -Id "MyId" Invoke-VcfOpsCreatePolicy -policy $policy </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreatePolicy with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Policy = Initialize-VcfOpsPolicy -Name "MyName" Invoke-VcfOpsCreatePolicy -policy $policy </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreatePolicy with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspolicy</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-VcfOpsDeletePolicy</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeletePolicy</command:noun> <maml:description> <maml:para>Delete policy for the specified identifier included descendants if requested.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete the policy for the specified identifier included descendants if requested</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeletePolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Policy identifier to delete</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>DeleteDescendants</maml:name> <maml:Description> <maml:para>True to delete all policies including descendants.</maml:para> </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>Id</maml:name> <maml:Description> <maml:para>Policy identifier to delete</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>DeleteDescendants</maml:name> <maml:Description> <maml:para>True to delete all policies including descendants.</maml:para> </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>Invoke-VcfOpsDeletePolicy -id "id_example" -deleteDescendants $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeletePolicy with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeletePolicy -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeletePolicy with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/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-VcfOpsDeletePolicySettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeletePolicySettings</command:noun> <maml:description> <maml:para>Make provided settings in the policy inherited from parent policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Make provided settings in the policy inherited from parent policy.<br/><b>NOTE:</b> Currently, only one resource kind is supported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeletePolicySettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Policy identifier</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>Type</maml:name> <maml:Description> <maml:para>Types of policy settings to delete.</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>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind 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>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind identifiers</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>Id</maml:name> <maml:Description> <maml:para>Policy identifier</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>Type</maml:name> <maml:Description> <maml:para>Types of policy settings to delete.</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>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind 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>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind identifiers</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-VcfOpsDeletePolicySettings -id "id_example" -type "VC_PRICING_POLICY_STATUS" -adapterKind "adapterKind_example" -resourceKind "MyresourceKind" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeletePolicySettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeletePolicySettings -id "id_example" -type "VC_PRICING_POLICY_STATUS" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeletePolicySettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/id/settings/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-VcfOpsExportPolicies</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsExportPolicies</command:noun> <maml:description> <maml:para>Export the content of policies into ZIP archive.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports the content of policies into ZIP archive. The format of the exported data is subject to change and should be used only in the scope of same product version. Note: while exporting an embedded policy its parent will be exported as well.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsExportPolicies</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Policy identifiers to export</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Policy identifiers to export</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>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-VcfOpsExportPolicies -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsExportPolicies with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsExportPolicies -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsExportPolicies with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/export/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-VcfOpsGetPolicies</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetPolicies</command:noun> <maml:description> <maml:para>Get all available policies.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns all available policies.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetPolicies</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActivesOnly</maml:name> <maml:Description> <maml:para>True to get only active policies (the ones that have priority, and default 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>false</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActivesOnly</maml:name> <maml:Description> <maml:para>True to get only active policies (the ones that have priority, and default 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>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicySummariesCollection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetPolicies -activesOnly $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetPolicies with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetPolicies </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetPolicies with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/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-VcfOpsGetPolicySettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetPolicySettings</command:noun> <maml:description> <maml:para>Get policy settings for the specified identifier.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the policy settings for the specified identifier.<br/><b>NOTE:</b> Currently, only one resource kind is supported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetPolicySettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Policy identifier to get</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>Type</maml:name> <maml:Description> <maml:para>Types of policy settings to retrieve.</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>IncludeInherited</maml:name> <maml:Description> <maml:para>True to obtain complete configuration, included inherited settings from parent policies</maml:para> </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>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind 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>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind identifiers</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>Id</maml:name> <maml:Description> <maml:para>Policy identifier to get</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>Type</maml:name> <maml:Description> <maml:para>Types of policy settings to retrieve.</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>IncludeInherited</maml:name> <maml:Description> <maml:para>True to obtain complete configuration, included inherited settings from parent policies</maml:para> </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>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind 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>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind identifiers</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>VMware.Bindings.Vcf.Ops.Model.PolicySettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetPolicySettings -id "id_example" -type "VC_PRICING_POLICY_STATUS" -includeInherited $false -adapterKind "adapterKind_example" -resourceKind "MyresourceKind" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetPolicySettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetPolicySettings -id "id_example" -type "VC_PRICING_POLICY_STATUS" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetPolicySettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/id/settings/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-VcfOpsImportPolicies</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsImportPolicies</command:noun> <maml:description> <maml:para>Import policy content from an archive of ZIP format</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Imports policy content from an archive of ZIP format.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsImportPolicies</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Policy</maml:name> <maml:Description> <maml:para>An archive of policy content to be imported</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>ForceImport</maml:name> <maml:Description> <maml:para>True to overwrite the existing policies, false to skip importing when there is a conflict</maml:para> </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>Policy</maml:name> <maml:Description> <maml:para>An archive of policy content to be imported</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>ForceImport</maml:name> <maml:Description> <maml:para>True to overwrite the existing policies, false to skip importing when there is a conflict</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.PolicyUpdateOutcome</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsImportPolicies -policy -forceImport $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsImportPolicies with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsImportPolicies -policy </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsImportPolicies with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/import/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-VcfOpsPatchPolicySettings</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsPatchPolicySettings</command:noun> <maml:description> <maml:para>Update only provided settings in the policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update only provided settings in the policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsPatchPolicySettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Policy identifier to update</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>PolicySettings</maml:name> <maml:Description> <maml:para>Only the specified fields in the settings will be applied to the provided policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicySettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicySettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>Policy identifier to update</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>PolicySettings</maml:name> <maml:Description> <maml:para>Only the specified fields in the settings will be applied to the provided policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicySettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicySettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PricingPolicyStatusSettings = Initialize-VcfOpsPricingPolicyStatusSettings -PolicyId "MyPolicyId" -Inherited $false $OneOfBasicChargesSetting = Initialize-VcfOpsOneOfBasicChargesSetting $VcGuestOsRateSettings = Initialize-VcfOpsVcGuestOsRateSettings -PolicyId "MyPolicyId" -Inherited $false $PricingTagsSettings = Initialize-VcfOpsPricingTagsSettings -PolicyId "MyPolicyId" -Inherited $false $OverallChargesSettings = Initialize-VcfOpsOverallChargesSettings -PolicyId "MyPolicyId" -Inherited $false $VcPricingSettings = Initialize-VcfOpsVcPricingSettings -PricingPolicyStatus $PricingPolicyStatusSettings -BasicCharges $OneOfBasicChargesSetting -GuestOSRate $VcGuestOsRateSettings -Tags $PricingTagsSettings -OverallCharges $OverallChargesSettings $WorkloadOptimizationSettings = Initialize-VcfOpsWorkloadOptimizationSettings -PolicyId "MyPolicyId" -Inherited $false $ClusterHeadroomSettings = Initialize-VcfOpsClusterHeadroomSettings -PolicyId "MyPolicyId" -Inherited $false $ChangeDatastoreSettings = Initialize-VcfOpsChangeDatastoreSettings -PolicyId "MyPolicyId" -Inherited $false $TargetNetworkSettings = Initialize-VcfOpsTargetNetworkSettings -PolicyId "MyPolicyId" -Inherited $false $WorkloadAutomationSettings = Initialize-VcfOpsWorkloadAutomationSettings -WorkloadOptimization $WorkloadOptimizationSettings -ClusterHeadroom $ClusterHeadroomSettings -ChangeDatastore $ChangeDatastoreSettings -TargetNetwork $TargetNetworkSettings $CapacityAllocationSettings = Initialize-VcfOpsCapacityAllocationSettings $CustomProfileSettings = Initialize-VcfOpsCustomProfileSettings $CapacityBufferSettings = Initialize-VcfOpsCapacityBufferSettings $Capacity = Initialize-VcfOpsCapacity -CapacityAllocationSettings $CapacityAllocationSettings -CustomProfileSettings $CustomProfileSettings -CapacityBufferSettings $CapacityBufferSettings $CriticalityThresholdsSettings = Initialize-VcfOpsCriticalityThresholdsSettings $CriticalityThresholds = Initialize-VcfOpsCriticalityThresholds -TimeRemainingSettings $CriticalityThresholdsSettings -CapacityRemainingSettings $CriticalityThresholdsSettings -WorkloadSettings $CriticalityThresholdsSettings $CapacitySettings = Initialize-VcfOpsCapacitySettings -Capacity $Capacity -CriticalityThresholds $CriticalityThresholds $PolicySettings = Initialize-VcfOpsPolicySettings -VcPricingSettings $VcPricingSettings -WorkloadAutomationSettings $WorkloadAutomationSettings -CapacitySettings $CapacitySettings Invoke-VcfOpsPatchPolicySettings -id "id_example" -policySettings $policySettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchPolicySettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PolicySettings = Initialize-VcfOpsPolicySettings Invoke-VcfOpsPatchPolicySettings -id "id_example" -policySettings $policySettings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsPatchPolicySettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/id/settings/patch//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspolicysettings</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-VcfOpsSetDefaultPolicy</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSetDefaultPolicy</command:noun> <maml:description> <maml:para>Set given policy as default policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set given policy as default policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSetDefaultPolicy</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">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>No description available.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsSetDefaultPolicy -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetDefaultPolicy with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsSetDefaultPolicy -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetDefaultPolicy with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/default/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-VcfOpsUnassignPolicy</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUnassignPolicy</command:noun> <maml:description> <maml:para>Unassign policy from given groups, and objects</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unassign policy from given groups, and objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUnassignPolicy</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">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>PolicyUnassignmentParam</maml:name> <maml:Description> <maml:para>The Policy unassignment object carrying ids of groups, and objects</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicyUnassignmentParam</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyUnassignmentParam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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">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>PolicyUnassignmentParam</maml:name> <maml:Description> <maml:para>The Policy unassignment object carrying ids of groups, and objects</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicyUnassignmentParam</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyUnassignmentParam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyAssociationsUpdateResult</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PolicyUnassignmentParam = Initialize-VcfOpsPolicyUnassignmentParam -GroupIds "MyGroupIds" -ResourceIds "MyResourceIds" Invoke-VcfOpsUnassignPolicy -id "id_example" -policyUnassignmentParam $policyUnassignmentParam </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnassignPolicy with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PolicyUnassignmentParam = Initialize-VcfOpsPolicyUnassignmentParam Invoke-VcfOpsUnassignPolicy -id "id_example" -policyUnassignmentParam $policyUnassignmentParam </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnassignPolicy with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/id/unassign/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspolicyunassignmentparam</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-VcfOpsUpdatePriorities</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdatePriorities</command:noun> <maml:description> <maml:para>Update priority order of provided policies</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The priorities will be set based on the order of the provided policies. Additionally, it's necessary to include all active policies except for the default policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdatePriorities</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyPriorities</maml:name> <maml:Description> <maml:para>Ids of the active none-default policies in a desired priority order.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicyPriorities</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyPriorities</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyPriorities</maml:name> <maml:Description> <maml:para>Ids of the active none-default policies in a desired priority order.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PolicyPriorities</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PolicyPriorities</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PolicyPriorities = Initialize-VcfOpsPolicyPriorities -PolicyIds "MyPolicyIds" Invoke-VcfOpsUpdatePriorities -policyPriorities $policyPriorities </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdatePriorities with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PolicyPriorities = Initialize-VcfOpsPolicyPriorities -PolicyIds "MyPolicyIds" Invoke-VcfOpsUpdatePriorities -policyPriorities $policyPriorities </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdatePriorities with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/policies/priorities/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspolicypriorities</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-VcfOpsGetLicenseInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetLicenseInfo</command:noun> <maml:description> <maml:para>Get the license info for VMware Cloud Foundation Operations instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the license info for VMware Cloud Foundation Operations instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetLicenseInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LicenseInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetLicenseInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLicenseInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetLicenseInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLicenseInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/product/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-VcfOpsGetNPCStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetNPCStatus</command:noun> <maml:description> <maml:para>Get native public cloud licensing status</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get native public cloud licensing status</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetNPCStatus</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ProductLicensingNpcStatus</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetNPCStatus </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNPCStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetNPCStatus </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetNPCStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/product/licensing/npc/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-VcfOpsGetProductEdition</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetProductEdition</command:noun> <maml:description> <maml:para>Get edition of product licensing</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get edition of product licensing</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetProductEdition</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ProductLicensing</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetProductEdition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetProductEdition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetProductEdition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetProductEdition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/product/licensing/edition/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-VcfOpsCreateRecommendation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateRecommendation</command:noun> <maml:description> <maml:para>Create a recommendation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The recommendation identifier must be unique for the system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateRecommendation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Recommendation</maml:name> <maml:Description> <maml:para>The Recommendation to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Recommendation</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Recommendation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Recommendation</maml:name> <maml:Description> <maml:para>The Recommendation to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Recommendation</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Recommendation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Recommendation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$RecommendedAction = Initialize-VcfOpsRecommendedAction -ActionAdapterKindId "MyActionAdapterKindId" -TargetAdapterKindId "MyTargetAdapterKindId" -TargetResourceKindId "MyTargetResourceKindId" -TargetMethod "MyTargetMethod" $Recommendation = Initialize-VcfOpsRecommendation -Id "MyId" -Description "MyDescription" -Action $RecommendedAction Invoke-VcfOpsCreateRecommendation -recommendation $recommendation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateRecommendation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Recommendation = Initialize-VcfOpsRecommendation -Description "MyDescription" Invoke-VcfOpsCreateRecommendation -recommendation $recommendation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateRecommendation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/recommendations/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsrecommendation</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-VcfOpsDeleteRecommendation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteRecommendation</command:noun> <maml:description> <maml:para>Delete a recommendation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If a recommendation with the specified identifier does not exist no error will be returned</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteRecommendation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the recommendation to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>If true,then delete recommendation and if it is referenced in problem definition, update corresponding problem definition to remove the reference. If false, then delete recommendation only if it is not referenced by any problem definition.</maml:para> </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>The identifier of the recommendation to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>If true,then delete recommendation and if it is referenced in problem definition, update corresponding problem definition to remove the reference. If false, then delete recommendation only if it is not referenced by any problem definition.</maml:para> </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-VcfOpsDeleteRecommendation -id "id_example" -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteRecommendation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteRecommendation -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteRecommendation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/recommendations/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-VcfOpsGetRecommendationById</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetRecommendationById</command:noun> <maml:description> <maml:para>Get the recommendation specified by the given identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the recommendation specified by the given identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetRecommendationById</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the recommendation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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 identifier of the recommendation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Recommendation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetRecommendationById -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRecommendationById with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetRecommendationById -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRecommendationById with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/recommendations/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-VcfOpsGetRecommendations</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetRecommendations</command:noun> <maml:description> <maml:para>Get recommendations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no query set, all recommendations will be returned</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetRecommendations</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Get Recommendations with the matching id, both system defined and user defined</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>TargetAdapterKind</maml:name> <maml:Description> <maml:para>Get Recommendations that have an associated recommended action on and the action<br>is applicable to the resource of the specified adapter kind.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetResourceKind</maml:name> <maml:Description> <maml:para>Get Recommendations that have an associated recommended action on and the action<br>is applicable to the resource of the specified resource kind.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Get Recommendations with the matching id, both system defined and user defined</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>TargetAdapterKind</maml:name> <maml:Description> <maml:para>Get Recommendations that have an associated recommended action on and the action<br>is applicable to the resource of the specified adapter kind.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetResourceKind</maml:name> <maml:Description> <maml:para>Get Recommendations that have an associated recommended action on and the action<br>is applicable to the resource of the specified resource kind.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Recommendations</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetRecommendations -id "Myid" -targetAdapterKind "targetAdapterKind_example" -targetResourceKind "targetResourceKind_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRecommendations with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetRecommendations </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRecommendations with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/recommendations/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-VcfOpsUpdateRecommendation</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateRecommendation</command:noun> <maml:description> <maml:para>Update an existing recommendation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an existing recommendation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateRecommendation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Recommendation</maml:name> <maml:Description> <maml:para>The Recommendation to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Recommendation</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Recommendation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Recommendation</maml:name> <maml:Description> <maml:para>The Recommendation to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Recommendation</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Recommendation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Recommendation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$RecommendedAction = Initialize-VcfOpsRecommendedAction -ActionAdapterKindId "MyActionAdapterKindId" -TargetAdapterKindId "MyTargetAdapterKindId" -TargetResourceKindId "MyTargetResourceKindId" -TargetMethod "MyTargetMethod" $Recommendation = Initialize-VcfOpsRecommendation -Id "MyId" -Description "MyDescription" -Action $RecommendedAction Invoke-VcfOpsUpdateRecommendation -recommendation $recommendation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateRecommendation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Recommendation = Initialize-VcfOpsRecommendation -Description "MyDescription" Invoke-VcfOpsUpdateRecommendation -recommendation $recommendation </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateRecommendation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/recommendations/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsrecommendation</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-VcfOpsCreateReport</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateReport</command:noun> <maml:description> <maml:para>Generate (create) a Report using the specified Report Definition and for the specified Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generate (create) a Report using the specified Report Definition and for the specified Resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Report</maml:name> <maml:Description> <maml:para>The Report that needs to be generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Report</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Report</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Report</maml:name> <maml:Description> <maml:para>The Report that needs to be generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Report</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Report</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Report</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $Report = Initialize-VcfOpsReport -Id "MyId" -Name "MyName" -Description "MyDescription" -ResourceId "MyResourceId" -ReportDefinitionId "MyReportDefinitionId" -TraversalSpec $TraversalSpec -Subject "MySubject" -Owner "MyOwner" -CompletionTime "MyCompletionTime" -Status "MyStatus" -Links $Link Invoke-VcfOpsCreateReport -report $report </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateReport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Report = Initialize-VcfOpsReport -ResourceId "MyResourceId" -ReportDefinitionId "MyReportDefinitionId" Invoke-VcfOpsCreateReport -report $report </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateReport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reports/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsreport</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-VcfOpsCreateReportSchedule</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateReportSchedule</command:noun> <maml:description> <maml:para>Create a Report Schedule to generate a Report for the specified Report Definition and Resource(s)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>To specify the time zone add <i>X-Ops-API-Timezone</i> header with value of format e.g. Asia/Yerevan.<br>All the schedules created using this API will be configured to use GMT time zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateReportSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Report Definition identifier</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>ReportSchedule</maml:name> <maml:Description> <maml:para>The Report Schedule to create in the system</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ReportSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ReportSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>XOpsAPITimezone</maml:name> <maml:Description> <maml:para>Custom HTTP header used by Ops API clients to specify Timezone information.<br>This Timezone value will be typically used for Report Generation.<br>Either an abbreviation such as \"GMT\", \"PDT\" can be specified,<br>or a full name such as \"America/Los_Angeles\". Other<br>formats and representations are not supported.<br></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"GMT"</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>Report Definition identifier</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>ReportSchedule</maml:name> <maml:Description> <maml:para>The Report Schedule to create in the system</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ReportSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ReportSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>XOpsAPITimezone</maml:name> <maml:Description> <maml:para>Custom HTTP header used by Ops API clients to specify Timezone information.<br>This Timezone value will be typically used for Report Generation.<br>Either an abbreviation such as \"GMT\", \"PDT\" can be specified,<br>or a full name such as \"America/Los_Angeles\". Other<br>formats and representations are not supported.<br></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"GMT"</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ReportSchedule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false "UNKNOWN"$ReportSchedule = Initialize-VcfOpsReportSchedule -Id "MyId" -ReportDefinitionId "MyReportDefinitionId" -ResourceId "MyResourceId" -TraversalSpec $TraversalSpec -StartDate "MyStartDate" -WeekOfMonth "UNKNOWNN" -ReportScheduleType "UNKNOWN" -DaysOfTheWeek $TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false "UNKNOWN" -StartHour 0 -StartMinute 0 -Recurrence 0 -DayOfTheMonth 0 -EmailAddresses "MyEmailAddresses" -EmailCcAddresses "MyEmailCcAddresses" -EmailBccAddresses "MyEmailBccAddresses" -EmailPluginId "MyEmailPluginId" -NetworkSharePluginId "MyNetworkSharePluginId" -RelativePath "MyRelativePath" Invoke-VcfOpsCreateReportSchedule -id "id_example" -reportSchedule $reportSchedule -xOpsAPITimezone "\"GMT\"" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateReportSchedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ReportSchedule = Initialize-VcfOpsReportSchedule -ReportDefinitionId "MyReportDefinitionId" -StartDate "MyStartDate" -Recurrence 0 -DayOfTheMonth 0 -RelativePath "MyRelativePath" Invoke-VcfOpsCreateReportSchedule -id "id_example" -reportSchedule $reportSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateReportSchedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reportdefinitions/id/schedules/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsreportschedule</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-VcfOpsDeleteReport</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteReport</command:noun> <maml:description> <maml:para>Delete a report by its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a report by its identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Report identifier</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>Report identifier</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteReport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteReport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reports/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-VcfOpsDeleteSchedule</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteSchedule</command:noun> <maml:description> <maml:para>Delete Report Schedule associated with the specific Report Definition and for the specified Schedule identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete Report Schedule associated with the specific Report Definition and for the specified Schedule identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Report Definition identifier</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>ScheduleId</maml:name> <maml:Description> <maml:para>The Report Schedule identifier</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>The Report Definition identifier</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>ScheduleId</maml:name> <maml:Description> <maml:para>The Report Schedule identifier</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteSchedule -id "id_example" -scheduleId "scheduleId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteSchedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteSchedule -id "id_example" -scheduleId "scheduleId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteSchedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reportdefinitions/id/schedules/scheduleId/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-VcfOpsDownloadReport</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDownloadReport</command:noun> <maml:description> <maml:para>Download the Report given its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The supported formats for Reports are PDF, CSV. If the format is not<br>specified the downloaded report will be in PDF format.<br> <b>NOTE:</b> In case the Accept header is provided, ensure that its value corresponds to the 'format' request parameter (including the default value when the request parameter is omitted).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDownloadReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the Report</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>Format</maml:name> <maml:Description> <maml:para>The format of the Report</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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 Identifier of the Report</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>Format</maml:name> <maml:Description> <maml:para>The format of the Report</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml: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-VcfOpsDownloadReport -id "id_example" -format "format_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownloadReport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDownloadReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDownloadReport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reports/id/download/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-VcfOpsGetReport</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetReport</command:noun> <maml:description> <maml:para>Get the detail of a Report given its identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the detail of a Report given its identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the Report</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>The Identifier of the Report</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>VMware.Bindings.Vcf.Ops.Model.Report</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetReport -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reports/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-VcfOpsGetReportDefinition</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetReportDefinition</command:noun> <maml:description> <maml:para>Get a Report Definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Report Definition by identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetReportDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Report Definition identifier</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>The Report Definition identifier</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>VMware.Bindings.Vcf.Ops.Model.ReportDefinition</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetReportDefinition -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportDefinition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetReportDefinition -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportDefinition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reportdefinitions/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-VcfOpsGetReportDefinitions</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetReportDefinitions</command:noun> <maml:description> <maml:para>Get the Report Definitions based on the query specification specified</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Report Definitions based on the query specification specified</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetReportDefinitions</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Names of the Report Definitions</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>Subject</maml:name> <maml:Description> <maml:para>Subjects of the Report Definitions</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>Owner</maml:name> <maml:Description> <maml:para>Owners of the Report Definitions</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>Names of the Report Definitions</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>Subject</maml:name> <maml:Description> <maml:para>Subjects of the Report Definitions</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>Owner</maml:name> <maml:Description> <maml:para>Owners of the Report Definitions</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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ReportDefinitions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetReportDefinitions -name "Myname" -subject "Mysubject" -owner "Myowner" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportDefinitions with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetReportDefinitions </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportDefinitions with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reportdefinitions/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-VcfOpsGetReportSchedule</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetReportSchedule</command:noun> <maml:description> <maml:para>Get a specific Report Schedule for the specified Report Definition and Schedule identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The date and time values configured within the Report Schedule are converted to GMT time zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetReportSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Report Definition identifier</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>ScheduleId</maml:name> <maml:Description> <maml:para>The Report Schedule identifier</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>The Report Definition identifier</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>ScheduleId</maml:name> <maml:Description> <maml:para>The Report Schedule identifier</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>VMware.Bindings.Vcf.Ops.Model.ReportSchedule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetReportSchedule -id "id_example" -scheduleId "scheduleId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportSchedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetReportSchedule -id "id_example" -scheduleId "scheduleId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportSchedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reportdefinitions/id/schedules/scheduleId/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-VcfOpsGetReportSchedules</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetReportSchedules</command:noun> <maml:description> <maml:para>Get all the Report Schedules associated with a Report Definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The date and time values configured within the Report Schedule are converted to GMT time zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetReportSchedules</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Report Definition identifier</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>IncludeResourcelessSchedules</maml:name> <maml:Description> <maml:para>Flag to include schedules with not-existing resource</maml:para> </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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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 Report Definition identifier</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>IncludeResourcelessSchedules</maml:name> <maml:Description> <maml:para>Flag to include schedules with not-existing resource</maml:para> </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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ReportSchedules</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetReportSchedules -id "id_example" -includeResourcelessSchedules $false -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportSchedules with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetReportSchedules -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReportSchedules with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reportdefinitions/id/schedules/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-VcfOpsGetReports</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetReports</command:noun> <maml:description> <maml:para>Get the Reports based on the Report Query Spec provided</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the query spec is not provided, all Reports present in the system are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetReports</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Reports name with which the filtering can be done</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>Subject</maml:name> <maml:Description> <maml:para>Subjects with which the filtering can be done</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>Status</maml:name> <maml:Description> <maml:para>Status of the report</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>ResourceId</maml:name> <maml:Description> <maml:para>Resources on which the reports are generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>Reports name with which the filtering can be done</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>Subject</maml:name> <maml:Description> <maml:para>Subjects with which the filtering can be done</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>Status</maml:name> <maml:Description> <maml:para>Status of the report</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>ResourceId</maml:name> <maml:Description> <maml:para>Resources on which the reports are generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Reports</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetReports -name "Myname" -subject "Mysubject" -status "Mystatus" -resourceId "MyresourceId" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReports with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetReports </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetReports with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reports/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-VcfOpsUpdateReportSchedule</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateReportSchedule</command:noun> <maml:description> <maml:para>Update Report Schedule associated with the specific Report Definition and for the specified Schedule identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The update of a schedule is a \"Replace\" operation.<br/>If a schedule with the specified <br>schedule id is present in the system it will be replaced else the API returns a 404 error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateReportSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Report Definition identifier</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>ReportSchedule</maml:name> <maml:Description> <maml:para>The Report Schedule to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ReportSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ReportSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 Report Definition identifier</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>ReportSchedule</maml:name> <maml:Description> <maml:para>The Report Schedule to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ReportSchedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ReportSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ReportSchedule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false "UNKNOWN"$ReportSchedule = Initialize-VcfOpsReportSchedule -Id "MyId" -ReportDefinitionId "MyReportDefinitionId" -ResourceId "MyResourceId" -TraversalSpec $TraversalSpec -StartDate "MyStartDate" -WeekOfMonth "UNKNOWNN" -ReportScheduleType "UNKNOWN" -DaysOfTheWeek $TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false "UNKNOWN" -StartHour 0 -StartMinute 0 -Recurrence 0 -DayOfTheMonth 0 -EmailAddresses "MyEmailAddresses" -EmailCcAddresses "MyEmailCcAddresses" -EmailBccAddresses "MyEmailBccAddresses" -EmailPluginId "MyEmailPluginId" -NetworkSharePluginId "MyNetworkSharePluginId" -RelativePath "MyRelativePath" Invoke-VcfOpsUpdateReportSchedule -id "id_example" -reportSchedule $reportSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateReportSchedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ReportSchedule = Initialize-VcfOpsReportSchedule -ReportDefinitionId "MyReportDefinitionId" -StartDate "MyStartDate" -Recurrence 0 -DayOfTheMonth 0 -RelativePath "MyRelativePath" Invoke-VcfOpsUpdateReportSchedule -id "id_example" -reportSchedule $reportSchedule </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateReportSchedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/reportdefinitions/id/schedules/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsreportschedule</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-VcfOpsAddProperties</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddProperties</command:noun> <maml:description> <maml:para>Add Properties to a Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In this case, the adapter instance used for pushing data will default to <i>SuiteAPI</i>. It is recommended (though not required) to use this API when the resource was created using the API <br><code>POST /api/resources/{id}/adapters/{adapterInstanceId}</code>. Otherwise an additional adapter instance might be created.<br><b>Note: </b> Those properties that are specified with old timestamp will be published with current time. As a result, only one of those properties will appear in vROps (e.g. the latest one will overwrite all previous ones).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddProperties</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 resource</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>PropertyContents</maml:name> <maml:Description> <maml:para>The properties for the Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 resource</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>PropertyContents</maml:name> <maml:Description> <maml:para>The properties for the Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent Invoke-VcfOpsAddProperties -id "id_example" -propertyContents $propertyContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddProperties with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent Invoke-VcfOpsAddProperties -id "id_example" -propertyContents $propertyContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddProperties with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/properties/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspropertycontents</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-VcfOpsAddPropertiesUsingPushAdapterKind</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddPropertiesUsingPushAdapterKind</command:noun> <maml:description> <maml:para>Add Properties to a Resource along with associating an adapter instance of the specified adapter kind as the source of data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the adapter kind specified is not present in the system, it will be created dynamically. However if the adapter kind specified already exists, then it must be of <i>OPENAPI</i> adapter kind type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddPropertiesUsingPushAdapterKind</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The Adapter Kind key of the adapter instance that will push the properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <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 resource</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>PropertyContents</maml:name> <maml:Description> <maml:para>The properties for the Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The Adapter Kind key of the adapter instance that will push the properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <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 resource</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>PropertyContents</maml:name> <maml:Description> <maml:para>The properties for the Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent Invoke-VcfOpsAddPropertiesUsingPushAdapterKind -adapterKind "adapterKind_example" -id "id_example" -propertyContents $propertyContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddPropertiesUsingPushAdapterKind with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent Invoke-VcfOpsAddPropertiesUsingPushAdapterKind -adapterKind "adapterKind_example" -id "id_example" -propertyContents $propertyContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddPropertiesUsingPushAdapterKind with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/properties/adapterkinds/adapterKind/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspropertycontents</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-VcfOpsAddRelationship</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddRelationship</command:noun> <maml:description> <maml:para>Add relationships of given type to the resource with specified resourceId</maml:para> </maml:description> </command:details> <maml:description> <maml:para><p><ul><li>If at least a few of the Resource that are part of <i>relatedIds</i> list<br>are valid resources then the operation is performed. </li><br><li>If there are few Resource that are part of <i>relatedIds</i> list<br>that will result in a cyclical relationship, then those resources will be skipped.</li><br></ul></p><p><b>NOTE: </b> Adding relationship is <em>not synchronous</em>. As a<br>result, the add operation may not happen immediately. It is recommended<br>to query the relationships of the specific Resource back to ensure that the<br>operation was indeed successful.<br></p></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddRelationship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The UUID of the source resource</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>RelationshipType</maml:name> <maml:Description> <maml:para>The type of relationship of the objects; Uses the RelationshipType.representation 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>UUID of resources to add as related to this resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 UUID of the source resource</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>RelationshipType</maml:name> <maml:Description> <maml:para>The type of relationship of the objects; Uses the RelationshipType.representation 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>UUID of resources to add as related to this resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsAddRelationship -id "id_example" -relationshipType "parents" -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddRelationship with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsAddRelationship -id "id_example" -relationshipType "parents" -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddRelationship with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/relationships/relationshipType/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuuidvalues</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-VcfOpsAddStats</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddStats</command:noun> <maml:description> <maml:para>Add Stats to a Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In this case, the adapter instance used for pushing data will default to <i>vRealizeOpsMgrAPI</i>. It is recommended (though not required) to use this API when the resource was created using the API <code>POST /api/resources/{id}/adapters/{adapterInstanceId}</code>. Otherwise an additional adapter instance might be created.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddStats</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the resource object</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>StatContents</maml:name> <maml:Description> <maml:para>The stats for the Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableAnalyticsProcessing</maml:name> <maml:Description> <maml:para>Whether the current data set goes through Analytics processing (Threshold checking, Alert generation) or not. Defaults to false. But when set to true will result in no evaluation of Alerts but the data gets stored.</maml:para> </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>The Identifier of the resource object</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>StatContents</maml:name> <maml:Description> <maml:para>The stats for the Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableAnalyticsProcessing</maml:name> <maml:Description> <maml:para>Whether the current data set goes through Analytics processing (Threshold checking, Alert generation) or not. Defaults to false. But when set to true will result in no evaluation of Alerts but the data gets stored.</maml:para> </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>$StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $StatContents = Initialize-VcfOpsStatContents -StatContent $StatContent Invoke-VcfOpsAddStats -id "id_example" -statContents $statContents -disableAnalyticsProcessing $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddStats with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 $StatContents = Initialize-VcfOpsStatContents -StatContent $StatContent Invoke-VcfOpsAddStats -id "id_example" -statContents $statContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddStats with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/stats/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsstatcontents</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-VcfOpsAddStatsUsingPushAdapterKind</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddStatsUsingPushAdapterKind</command:noun> <maml:description> <maml:para>Add Stats to a Resource along with associating an adapter instance of the specified adapter kind as the source of data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the adapter kind specified is not present in the system, it will be created dynamically. However if the adapter kind specified already exists, then it must be of <i>OPENAPI</i> adapter kind type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddStatsUsingPushAdapterKind</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The ID of the adapter kind that will push the stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the resource object</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>StatContents</maml:name> <maml:Description> <maml:para>The stats for the Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableAnalyticsProcessing</maml:name> <maml:Description> <maml:para>Whether the current data set goes through Analytics processing (Threshold checking, Alert generation) or not. Defaults to false. But when set to true will result in no evaluation of Alerts but the data gets stored.</maml:para> </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>AdapterKind</maml:name> <maml:Description> <maml:para>The ID of the adapter kind that will push the stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the resource object</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>StatContents</maml:name> <maml:Description> <maml:para>The stats for the Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableAnalyticsProcessing</maml:name> <maml:Description> <maml:para>Whether the current data set goes through Analytics processing (Threshold checking, Alert generation) or not. Defaults to false. But when set to true will result in no evaluation of Alerts but the data gets stored.</maml:para> </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>$StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $StatContents = Initialize-VcfOpsStatContents -StatContent $StatContent Invoke-VcfOpsAddStatsUsingPushAdapterKind -adapterKind "adapterKind_example" -id "id_example" -statContents $statContents -disableAnalyticsProcessing $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddStatsUsingPushAdapterKind with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 $StatContents = Initialize-VcfOpsStatContents -StatContent $StatContent Invoke-VcfOpsAddStatsUsingPushAdapterKind -adapterKind "adapterKind_example" -id "id_example" -statContents $statContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddStatsUsingPushAdapterKind with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/stats/adapterkinds/adapterKind/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsstatcontents</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-VcfOpsDeleteRelationship</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteRelationship</command:noun> <maml:description> <maml:para>Delete (remove) a Resource as RelationshipType of a specific Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para><p><b>NOTE: </b> Removing a relationship is <em>not synchronous</em>. As a<br>result, the delete operation may not happen immediately. It is recommended<br>to query the relationships of the specific Resource back to ensure that the<br>operation was indeed successful.</p></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteRelationship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The UUID of the resource</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>RelationshipType</maml:name> <maml:Description> <maml:para>Type of the Relationship that needs to be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RelatedId</maml:name> <maml:Description> <maml:para>The UUID of the resource to remove from relationship</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>The UUID of the resource</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>RelationshipType</maml:name> <maml:Description> <maml:para>Type of the Relationship that needs to be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RelatedId</maml:name> <maml:Description> <maml:para>The UUID of the resource to remove from relationship</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteRelationship -id "id_example" -relationshipType "relationshipType_example" -relatedId "relatedId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteRelationship with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteRelationship -id "id_example" -relationshipType "relationshipType_example" -relatedId "relatedId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteRelationship with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/relationships/relationshipType/relatedId/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-VcfOpsDeleteResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteResource</command:noun> <maml:description> <maml:para>Delete a Resource with the given identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para><p><b>NOTE: </b> Deletion of a Resource is <em>not synchronous</em>. As a result, the delete operation may not happen immediately. It is recommended to query back the system with the resource identifier and ensure that the system returns a 404 error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifier</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>The Resource identifier</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteResource -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteResource -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/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-VcfOpsGetDTStatsOfResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetDTStatsOfResource</command:noun> <maml:description> <maml:para>Get Stats and Dynamic Threshold values for one or more StatKeys and for a Collection of Resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The API returns 24 hours of Stats and DT data by default for the specified Resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetDTStatsOfResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Collection of Resource identifiers for which Stats and DT values need to be retrieved</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Collection of StatKeys for which Stats and DT values need to be retrieved</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>Id</maml:name> <maml:Description> <maml:para>The Identifier of the resource object</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>long value is number of milliseconds since January 1, 1970 00:00:00 UTC</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>ShowSmooth</maml:name> <maml:Description> <maml:para>Flag that indicates whether stats should be smoothened or not. Default value is 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SmoothFactor</maml:name> <maml:Description> <maml:para>The smooth precision, default value is 2.0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double?</command:parameterValue> <dev:type> <maml:name>double?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>Collection of Resource identifiers for which Stats and DT values need to be retrieved</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Collection of StatKeys for which Stats and DT values need to be retrieved</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>Id</maml:name> <maml:Description> <maml:para>The Identifier of the resource object</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>long value is number of milliseconds since January 1, 1970 00:00:00 UTC</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>ShowSmooth</maml:name> <maml:Description> <maml:para>Flag that indicates whether stats should be smoothened or not. Default value is 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SmoothFactor</maml:name> <maml:Description> <maml:para>The smooth precision, default value is 2.0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double?</command:parameterValue> <dev:type> <maml:name>double?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatsOfResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetDTStatsOfResource -resourceId "MyresourceId" -statKey "MystatKey" -id "id_example" -begin 789L -end 789L -showSmooth $true -smoothFactor 1.2D </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetDTStatsOfResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetDTStatsOfResource -resourceId "MyresourceId" -statKey "MystatKey" -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetDTStatsOfResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/stats/dt/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-VcfOpsGetLatestStats</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetLatestStats</command:noun> <maml:description> <maml:para>Get the latest stat for a given Resource and given a set of attributes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the latest stat for a given Resource and given a set of attributes</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetLatestStats</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The StatsQuery object which can be used to refine the query</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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the latest stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the latest stats should be returned</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>MaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest stats.<br>Defaults to 1 so that when processing the query if it is omitted<br>the response would contain a single sample</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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>Id</maml:name> <maml:Description> <maml:para>The StatsQuery object which can be used to refine the query</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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the latest stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the latest stats should be returned</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>MaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest stats.<br>Defaults to 1 so that when processing the query if it is omitted<br>the response would contain a single sample</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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.StatsOfResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetLatestStats -id "id_example" -resourceId "MyresourceId" -statKey "MystatKey" -metrics $true -currentOnly $true -maxSamples 56 -wrapStatValues $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLatestStats with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetLatestStats -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLatestStats with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/stats/latest/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-VcfOpsGetRelationship</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetRelationship</command:noun> <maml:description> <maml:para>Get the related resources of a particular Relationship Type for a Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The URL path variable <i>'relationshipType'</i> uses the RelationshipType.representation value.<br>Few sample URLs are shown below.<br><code>/api/resources/{resourceId}/relationships/children</code><br><code>/api/resources/{resourceId}/relationships/parents</code><br></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetRelationship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The UUID of the resource to set the relationships for</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>RelationshipType</maml:name> <maml:Description> <maml:para>The type of relationship of the objects; Uses the RelationshipType.representation 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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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 UUID of the resource to set the relationships for</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>RelationshipType</maml:name> <maml:Description> <maml:para>The type of relationship of the objects; Uses the RelationshipType.representation 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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceRelation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetRelationship -id "id_example" -relationshipType "PARENT" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRelationship with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetRelationship -id "id_example" -relationshipType "PARENT" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRelationship with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/relationships/relationshipType/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-VcfOpsGetRelationships</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetRelationships</command:noun> <maml:description> <maml:para>Get ALL the related resources of a particular Relationship Type for a Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the optional query parameter <i>'relationshipType'</i> is specified, relations of that particular Relationship Type are returned.<br>Few sample URLs are shown below.<br><code>/api/resources/{resourceId}/relationships?relationshipType=CHILD</code><br><code>/api/resources/{resourceId}/relationships?relationshipType=PARENT</code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetRelationships</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The UUID of the resource to set the relationships for</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>RelationshipType</maml:name> <maml:Description> <maml:para>The type of relationship of the objects; Uses the RelationshipType.representation 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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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 UUID of the resource to set the relationships for</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>RelationshipType</maml:name> <maml:Description> <maml:para>The type of relationship of the objects; Uses the RelationshipType.representation 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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceRelation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetRelationships -id "id_example" -relationshipType "PARENT" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRelationships with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetRelationships -id "id_example" -relationshipType "PARENT" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetRelationships with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/relationships/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-VcfOpsGetResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResource</command:noun> <maml:description> <maml:para>Get the Resource for the specified identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Resource for the specified identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifier</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>The Resource identifier</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>VMware.Bindings.Vcf.Ops.Model.Resource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResource -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResource -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/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-VcfOpsGetResourceProperties</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourceProperties</command:noun> <maml:description> <maml:para>Get all the properties for the specified Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all the properties for the specified Resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourceProperties</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 resource</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>The ID of the resource</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>VMware.Bindings.Vcf.Ops.Model.ResourceProperty</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourceProperties -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceProperties with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourceProperties -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourceProperties with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/properties/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-VcfOpsGetStatKeys</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetStatKeys</command:noun> <maml:description> <maml:para>Get all the stat keys for the specified Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all the stat keys for the specified Resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetStatKeys</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 resource</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>The ID of the resource</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>VMware.Bindings.Vcf.Ops.Model.StatKeys</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetStatKeys -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatKeys with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetStatKeys -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatKeys with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/statkeys/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-VcfOpsGetStatsForResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetStatsForResource</command:noun> <maml:description> <maml:para>Look up stats of a group of objects with the resource ids</maml:para> </maml:description> </command:details> <maml:description> <maml:para><i><b>NOTE:</b></i> When making an XML request, make sure the <i>statKey</i> field does not contain any key name with spaces.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetStatsForResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the resource object</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>StatQuery</maml:name> <maml:Description> <maml:para>The StatsQuery object which can be used to refine the query</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 Identifier of the resource object</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>StatQuery</maml:name> <maml:Description> <maml:para>The StatsQuery object which can be used to refine the query</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatsOfResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatQuery = Initialize-VcfOpsStatQuery -ResourceId "MyResourceId" -StatKey "MyStatKey" -Begin 0 -End 0 -RollUpType "SUM" -IntervalType "HOURS" -IntervalQuantifier 0 -Dt $false -LatestMaxSamples 0 -Metrics $false -CurrentOnly $false -WrapStatValues $false Invoke-VcfOpsGetStatsForResource -id "id_example" -statQuery $statQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsForResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StatQuery = Initialize-VcfOpsStatQuery Invoke-VcfOpsGetStatsForResource -id "id_example" -statQuery $statQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsForResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/stats/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsstatquery</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-VcfOpsGetStatsOfResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetStatsOfResource</command:noun> <maml:description> <maml:para>Look up stats of a group of objects with the resource ids</maml:para> </maml:description> </command:details> <maml:description> <maml:para>NOTE: Unless a time range is explicitly set, the method returns statKeys which have received data in the last 24 hours.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetStatsOfResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the resource object</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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>Rollup Type requested by the user (e.g.: AVG, MIN, MAX 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>IntervalType</maml:name> <maml:Description> <maml:para>Interval type requested by the user (e.g: Days, Weeks, Months 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>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>Id</maml:name> <maml:Description> <maml:para>The Identifier of the resource object</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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>Rollup Type requested by the user (e.g.: AVG, MIN, MAX 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>IntervalType</maml:name> <maml:Description> <maml:para>Interval type requested by the user (e.g: Days, Weeks, Months 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>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.StatsOfResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetStatsOfResource -id "id_example" -resourceId "MyresourceId" -statKey "MystatKey" -begin 789L -end 789L -rollUpType "SUM" -intervalType "HOURS" -intervalQuantifier 56 -dt $true -latestMaxSamples 56 -metrics $true -currentOnly $true -wrapStatValues $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsOfResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetStatsOfResource -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsOfResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/stats/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-VcfOpsGetTopNStatsOfResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetTopNStatsOfResource</command:noun> <maml:description> <maml:para>Get the TopN stats for a given Resource and given a set of attributes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the TopN stats for a given Resource and given a set of attributes</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetTopNStatsOfResource</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 resource</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>TopN</maml:name> <maml:Description> <maml:para>The number of results. Keep in mind if a grouping contains multiple items (eg:<br>grouped by resource, with 4 metrics for the grouping resource) then returning the group with<br>4 metrics counts as 4 topN entries. If there are not enough remaining open topN entries to<br>return an entire group within the topN then the entire group is not returned. *</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>GroupBy</maml:name> <maml:Description> <maml:para>The type of grouping, if not set defaults to ResourceStatGroupBy.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>SortOrder</maml:name> <maml:Description> <maml:para>The type of sorting, if not set defaults to ResourceStatSort.ASCENDING</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>Rollup Type requested by the user (e.g.: AVG, MIN, MAX 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>IntervalType</maml:name> <maml:Description> <maml:para>Interval type requested by the user (e.g: Days, Weeks, Months 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>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>Id</maml:name> <maml:Description> <maml:para>The ID of the resource</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>TopN</maml:name> <maml:Description> <maml:para>The number of results. Keep in mind if a grouping contains multiple items (eg:<br>grouped by resource, with 4 metrics for the grouping resource) then returning the group with<br>4 metrics counts as 4 topN entries. If there are not enough remaining open topN entries to<br>return an entire group within the topN then the entire group is not returned. *</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>GroupBy</maml:name> <maml:Description> <maml:para>The type of grouping, if not set defaults to ResourceStatGroupBy.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>SortOrder</maml:name> <maml:Description> <maml:para>The type of sorting, if not set defaults to ResourceStatSort.ASCENDING</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>Rollup Type requested by the user (e.g.: AVG, MIN, MAX 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>IntervalType</maml:name> <maml:Description> <maml:para>Interval type requested by the user (e.g: Days, Weeks, Months 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>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.ResourceStatGroupList</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetTopNStatsOfResource -id "id_example" -topN 56 -groupBy "RESOURCE" -sortOrder "ASCENDING" -resourceId "MyresourceId" -statKey "MystatKey" -begin 789L -end 789L -rollUpType "SUM" -intervalType "HOURS" -intervalQuantifier 56 -dt $true -latestMaxSamples 56 -metrics $true -currentOnly $true -wrapStatValues $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTopNStatsOfResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetTopNStatsOfResource -id "id_example" -topN 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTopNStatsOfResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/stats/topn/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-VcfOpsMarkResourceAsBeingMaintained</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsMarkResourceAsBeingMaintained</command:noun> <maml:description> <maml:para>Put the specific Resource in Maintenance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Resource can end up in two maintenance states - <i>MAINTAINED</i> OR <i>MAINTAINED_MANUAL</i> -<br>depending upon the inputs specified.<br/><ul><br><li>If duration/end time is specified, the resource will be placed in <i>MAINTAINED</i><br>state and after the duration/end time expires, the resource state is automatically set to the state<br>it was in before entering the maintenance window.<br><li>If duration/end time is not specified, the resource will be placed in <i>MAINTAINED_MANUAL</i> state.<br>Callers have to execute <code>DELETE /suite-api/api/resources/{id}/maintained</code> API to set the Resource<br>back to whatever state it was in.<br><li>If both duration and end time are specified, end time takes preference over duration.<br></ul></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsMarkResourceAsBeingMaintained</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifier</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>Duration</maml:name> <maml:Description> <maml:para>Duration for which this resource will be in maintenance (In Minutes)</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>End</maml:name> <maml:Description> <maml:para>End time of the maintenance window as a long value (Epoch time)</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>The Resource identifier</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>Duration</maml:name> <maml:Description> <maml:para>Duration for which this resource will be in maintenance (In Minutes)</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>End</maml:name> <maml:Description> <maml:para>End time of the maintenance window as a long value (Epoch time)</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-VcfOpsMarkResourceAsBeingMaintained -id "id_example" -duration 56 -end 789L </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsMarkResourceAsBeingMaintained with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsMarkResourceAsBeingMaintained -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsMarkResourceAsBeingMaintained with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/maintained/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-VcfOpsSetRelationship</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsSetRelationship</command:noun> <maml:description> <maml:para>Set (Replace) Resource as RelationshipType of a specific Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This API exposes replace semantics. Therefore, all the existing relationships of the<br>specified <i>relationshipType</i> will be removed and replaced with the resources<br>specified as part of the request body.<br><p><ul><li>If at least a few of the Resource that are part of <i>relatedIds</i> list<br>are valid resources then the operation is performed. </li><br><li>If there are few Resource that are part of <i>relatedIds</i> list<br>that will result in a cyclical relationship, then the operation is aborted.</li><br></ul></p><p><b>NOTE: </b> Setting relationship is <em>not synchronous</em>.<br>As a result, the set operation may not happen immediately. It is recommended<br>to query the relationships of the specific Resource back to ensure that the<br>operation was indeed successful.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsSetRelationship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The UUID of the source resource</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>RelationshipType</maml:name> <maml:Description> <maml:para>The type of relationship of the objects; Uses the RelationshipType.representation 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>UUID of resources to set as related to this resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 UUID of the source resource</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>RelationshipType</maml:name> <maml:Description> <maml:para>The type of relationship of the objects; Uses the RelationshipType.representation 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>UUID of resources to set as related to this resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsSetRelationship -id "id_example" -relationshipType "parents" -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetRelationship with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsSetRelationship -id "id_example" -relationshipType "parents" -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsSetRelationship with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/relationships/relationshipType/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuuidvalues</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-VcfOpsStartMonitoringResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsStartMonitoringResource</command:noun> <maml:description> <maml:para>Inform one or more or all Adapters to start monitoring this Resource. Note: Start isn't supported on per resource bases any more.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The optional query parameter <i>adapterId</i> determines which of the Adapters need to be informed to start monitoring the Resource. If this is not specified, then all of the Adapters will start monitoring the Resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsStartMonitoringResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifier</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>AdapterId</maml:name> <maml:Description> <maml:para>Collection of adapter instance identifiers that should start monitoring this Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>The Resource identifier</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>AdapterId</maml:name> <maml:Description> <maml:para>Collection of adapter instance identifiers that should start monitoring this Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsStartMonitoringResource -id "id_example" -adapterId "MyadapterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStartMonitoringResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsStartMonitoringResource -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStartMonitoringResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/monitoringstate/start/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-VcfOpsStopMonitoringResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsStopMonitoringResource</command:noun> <maml:description> <maml:para>Inform one or more or all Adapters to stop monitoring this Resource. Note: Stop isn't supported on per resource bases any more.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The optional query parameter <i>adapterId</i> determines which of the Adapters need to be informed to stop monitoring the Resource. If this is not specified, then all of the Adapters will stop monitoring the Resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsStopMonitoringResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifier</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>AdapterId</maml:name> <maml:Description> <maml:para>Collection of adapter instance identifiers that should stop monitoring this Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>The Resource identifier</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>AdapterId</maml:name> <maml:Description> <maml:para>Collection of adapter instance identifiers that should stop monitoring this Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsStopMonitoringResource -id "id_example" -adapterId "MyadapterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStopMonitoringResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsStopMonitoringResource -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStopMonitoringResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/monitoringstate/stop/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-VcfOpsUnmarkResourceAsBeingMaintained</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUnmarkResourceAsBeingMaintained</command:noun> <maml:description> <maml:para>Bring the Resource out of Maintenance manually</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Bring the Resource out of Maintenance manually</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUnmarkResourceAsBeingMaintained</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifier</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>The Resource identifier</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsUnmarkResourceAsBeingMaintained -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnmarkResourceAsBeingMaintained with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUnmarkResourceAsBeingMaintained -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnmarkResourceAsBeingMaintained with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/maintained/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-VcfOpsUpdateGeoLocationOfResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateGeoLocationOfResource</command:noun> <maml:description> <maml:para>Update the geographical location of the Resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the geographical location of the Resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateGeoLocationOfResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifier</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>Latitude</maml:name> <maml:Description> <maml:para>The latitude of the location</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Longitude</maml:name> <maml:Description> <maml:para>The longitude of the location</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 Resource identifier</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>Latitude</maml:name> <maml:Description> <maml:para>The latitude of the location</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Longitude</maml:name> <maml:Description> <maml:para>The longitude of the location</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsUpdateGeoLocationOfResource -id "id_example" -latitude 1.2D -longitude 1.2D </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateGeoLocationOfResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUpdateGeoLocationOfResource -id "id_example" -latitude 1.2D -longitude 1.2D </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateGeoLocationOfResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/id/geolocation/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-VcfOpsAddGroupType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddGroupType</command:noun> <maml:description> <maml:para>Add a new group type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add a new group type<br><b>NOTE: </b> The value of key must either not be sent or must match with the value of name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddGroupType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupTypes</maml:name> <maml:Description> <maml:para>The Group type to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.GroupTypes</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.GroupTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupTypes</maml:name> <maml:Description> <maml:para>The Group type to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.GroupTypes</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.GroupTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$GroupType = Initialize-VcfOpsGroupType -Name "MyName" -Key "MyKey" $GroupTypes = Initialize-VcfOpsGroupTypes -_GroupTypes $GroupType Invoke-VcfOpsAddGroupType -groupTypes $groupTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddGroupType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$GroupTypes = Initialize-VcfOpsGroupTypes Invoke-VcfOpsAddGroupType -groupTypes $groupTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddGroupType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/groups/types/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsgrouptypes</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-VcfOpsAddResourcesProperties</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddResourcesProperties</command:noun> <maml:description> <maml:para>Add Properties to Resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In this case, the adapter instance used for pushing data will default to <i>vRealizeOpsMgrAPI</i>.<br>It is recommended (though not required) to use this API when the resources were created using the API<br><code>POST /api/resources/{id}/adapters/{adapterInstanceId}</code>. Otherwise an additional<br>adapter instance might be created.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddResourcesProperties</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourcesPropertyContents</maml:name> <maml:Description> <maml:para>The properties for the Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourcesPropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesPropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourcesPropertyContents</maml:name> <maml:Description> <maml:para>The properties for the Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourcesPropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesPropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent $ResourcePropertyContents = Initialize-VcfOpsResourcePropertyContents -ResourceId "MyResourceId" -PropertyContents $PropertyContents $ResourcesPropertyContents = Initialize-VcfOpsResourcesPropertyContents -Values $ResourcePropertyContents Invoke-VcfOpsAddResourcesProperties -resourcesPropertyContents $resourcesPropertyContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddResourcesProperties with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourcesPropertyContents = Initialize-VcfOpsResourcesPropertyContents Invoke-VcfOpsAddResourcesProperties -resourcesPropertyContents $resourcesPropertyContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddResourcesProperties with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/properties/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcespropertycontents</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-VcfOpsAddResourcesPropertiesUsingAdapterKind</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddResourcesPropertiesUsingAdapterKind</command:noun> <maml:description> <maml:para>Add Properties to Resources Using Adapter Kind</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the adapter kind specified is not present in the system, it will be created dynamically.<br>However if the adapter kind specified already exists, then it must be of <i>OPENAPI</i> adapter kind type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddResourcesPropertiesUsingAdapterKind</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The Adapter Kind key of the adapter instance that will push the properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourcesPropertyContents</maml:name> <maml:Description> <maml:para>The properties for the Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourcesPropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesPropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The Adapter Kind key of the adapter instance that will push the properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourcesPropertyContents</maml:name> <maml:Description> <maml:para>The properties for the Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourcesPropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesPropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent $ResourcePropertyContents = Initialize-VcfOpsResourcePropertyContents -ResourceId "MyResourceId" -PropertyContents $PropertyContents $ResourcesPropertyContents = Initialize-VcfOpsResourcesPropertyContents -Values $ResourcePropertyContents Invoke-VcfOpsAddResourcesPropertiesUsingAdapterKind -adapterKind "adapterKind_example" -resourcesPropertyContents $resourcesPropertyContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddResourcesPropertiesUsingAdapterKind with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourcesPropertyContents = Initialize-VcfOpsResourcesPropertyContents Invoke-VcfOpsAddResourcesPropertiesUsingAdapterKind -adapterKind "adapterKind_example" -resourcesPropertyContents $resourcesPropertyContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddResourcesPropertiesUsingAdapterKind with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/properties/adapterkinds/adapterKind/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcespropertycontents</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-VcfOpsAddStatsForResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddStatsForResources</command:noun> <maml:description> <maml:para>Add Stats to a Collection of Resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In this case, the adapter instance used for pushing data will default to <i>vRealizeOpsMgrAPI</i>.<br>It is recommended (though not required) to use this API when the resources were created using the API<br><code>POST /api/resources/{id}/adapters/{adapterInstanceId}</code>. Otherwise an additional<br>adapter instance might be created.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddStatsForResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourcesStatContents</maml:name> <maml:Description> <maml:para>The Resources and their Stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourcesStatContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesStatContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableAnalyticsProcessing</maml:name> <maml:Description> <maml:para>Whether the current data set<br>goes through Analytics processing (Threshold checking, Alert generation) or not.<br>Defaults to false. But when set to true will result in no evaluation of Alerts<br>but the data gets stored</maml:para> </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>ResourcesStatContents</maml:name> <maml:Description> <maml:para>The Resources and their Stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourcesStatContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesStatContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableAnalyticsProcessing</maml:name> <maml:Description> <maml:para>Whether the current data set<br>goes through Analytics processing (Threshold checking, Alert generation) or not.<br>Defaults to false. But when set to true will result in no evaluation of Alerts<br>but the data gets stored</maml:para> </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>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $ResourceStatContent = Initialize-VcfOpsResourceStatContent -Id "MyId" -ResourceKey $ResourceKey -StatContents $StatContent $ResourcesStatContents = Initialize-VcfOpsResourcesStatContents -ResourceStatContent $ResourceStatContent Invoke-VcfOpsAddStatsForResources -resourcesStatContents $resourcesStatContents -disableAnalyticsProcessing $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddStatsForResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourcesStatContents = Initialize-VcfOpsResourcesStatContents Invoke-VcfOpsAddStatsForResources -resourcesStatContents $resourcesStatContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddStatsForResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/stats/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcesstatcontents</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-VcfOpsAddStatsForResourcesUsingPushAdapterKind</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsAddStatsForResourcesUsingPushAdapterKind</command:noun> <maml:description> <maml:para>Adds Stats to a Collection of Resources along with associating an adapter instance of the specified adapter kind as the source of data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the adapter kind specified is not present in the system, it will be created dynamically.<br>However if the adapter kind specified already exists, then it must be of <i>OPENAPI</i> adapter kind type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsAddStatsForResourcesUsingPushAdapterKind</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The ID of the adapter kind that will push the stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourcesStatContents</maml:name> <maml:Description> <maml:para>The Resources and their Stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourcesStatContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesStatContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableAnalyticsProcessing</maml:name> <maml:Description> <maml:para>Whether the current data set<br>goes through Analytics processing (Threshold checking, Alert generation) or not.<br>Defaults to false. But when set to true will result in no evaluation of Alerts<br>but the data gets stored.</maml:para> </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>AdapterKind</maml:name> <maml:Description> <maml:para>The ID of the adapter kind that will push the stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourcesStatContents</maml:name> <maml:Description> <maml:para>The Resources and their Stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourcesStatContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesStatContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisableAnalyticsProcessing</maml:name> <maml:Description> <maml:para>Whether the current data set<br>goes through Analytics processing (Threshold checking, Alert generation) or not.<br>Defaults to false. But when set to true will result in no evaluation of Alerts<br>but the data gets stored.</maml:para> </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>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $ResourceStatContent = Initialize-VcfOpsResourceStatContent -Id "MyId" -ResourceKey $ResourceKey -StatContents $StatContent $ResourcesStatContents = Initialize-VcfOpsResourcesStatContents -ResourceStatContent $ResourceStatContent Invoke-VcfOpsAddStatsForResourcesUsingPushAdapterKind -adapterKind "adapterKind_example" -resourcesStatContents $resourcesStatContents -disableAnalyticsProcessing $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddStatsForResourcesUsingPushAdapterKind with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourcesStatContents = Initialize-VcfOpsResourcesStatContents Invoke-VcfOpsAddStatsForResourcesUsingPushAdapterKind -adapterKind "adapterKind_example" -resourcesStatContents $resourcesStatContents </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsAddStatsForResourcesUsingPushAdapterKind with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/stats/adapterkinds/adapterKind/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcesstatcontents</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-VcfOpsCreateCustomDatacenter</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateCustomDatacenter</command:noun> <maml:description> <maml:para>Create a custom datacenter</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a custom datacenter</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateCustomDatacenter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomDatacenter</maml:name> <maml:Description> <maml:para>Custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomDatacenter</maml:name> <maml:Description> <maml:para>Custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CustomDatacenter = Initialize-VcfOpsCustomDatacenter -Id "MyId" -Name "MyName" -Description "MyDescription" -ChildResourceIds "MyChildResourceIds" Invoke-VcfOpsCreateCustomDatacenter -customDatacenter $customDatacenter </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCustomDatacenter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CustomDatacenter = Initialize-VcfOpsCustomDatacenter -Name "MyName" -ChildResourceIds "MyChildResourceIds" Invoke-VcfOpsCreateCustomDatacenter -customDatacenter $customDatacenter </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCustomDatacenter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/customdatacenters/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscustomdatacenter</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-VcfOpsCreateCustomGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateCustomGroup</command:noun> <maml:description> <maml:para>Create a new custom group definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>See different request examples with Metric Key, Property Key, Relationship and Resource Name Condition.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateCustomGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomGroup</maml:name> <maml:Description> <maml:para>The custom group definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomGroup</maml:name> <maml:Description> <maml:para>The custom group definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $CustomGroupProperty = Initialize-VcfOpsCustomGroupProperty -Name "MyName" -Type "STRING" -InclusionValue "MyInclusionValue" -ExclusionValue "MyExclusionValue" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $PropertyStatConditionRule = Initialize-VcfOpsPropertyStatConditionRule -Key "MyKey" -StringValue "MyStringValue" -DoubleValue 0 -CompareOperator "EQ" $ResourceNameConditionRule = Initialize-VcfOpsResourceNameConditionRule -Name "MyName" -CompareOperator "EQ" $RelationshipConditionRule = Initialize-VcfOpsRelationshipConditionRule -Relation "PARENT" -Name "MyName" -CompareOperator "EQ" -TravesalSpecId "MyTravesalSpecId" $ResourceTagConditionRule = Initialize-VcfOpsResourceTagConditionRule -Category "MyCategory" -CompareOperator "EQ" -StringValue "MyStringValue" $MembershipRuleGroup = Initialize-VcfOpsMembershipRuleGroup -ResourceKindKey $ResourceKindKey -StatConditionRules $PropertyStatConditionRule -PropertyConditionRules $PropertyStatConditionRule -ResourceNameConditionRules $ResourceNameConditionRule -RelationshipConditionRules $RelationshipConditionRule -ResourceTagConditionRules $ResourceTagConditionRule $CustomGroupMembership = Initialize-VcfOpsCustomGroupMembership -IncludedResources "MyIncludedResources" -ExcludedResources "MyExcludedResources" -CustomGroupProperties $CustomGroupProperty -Rules $MembershipRuleGroup $CustomGroup = Initialize-VcfOpsCustomGroup -Id "MyId" -ResourceKey $ResourceKey -Policy "MyPolicy" -AutoResolveMembership $false -MembershipDefinition $CustomGroupMembership -Links $Link Invoke-VcfOpsCreateCustomGroup -customGroup $customGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCustomGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $CustomGroupMembership = Initialize-VcfOpsCustomGroupMembership $CustomGroup = Initialize-VcfOpsCustomGroup -ResourceKey $ResourceKey -MembershipDefinition $CustomGroupMembership Invoke-VcfOpsCreateCustomGroup -customGroup $customGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCustomGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/groups/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscustomgroup</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-VcfOpsCreateCustomProfile</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateCustomProfile</command:noun> <maml:description> <maml:para>Create a new custom profile definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Example: <code>GET /api/alerts/{id}</code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateCustomProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomProfile</maml:name> <maml:Description> <maml:para>The custom profile definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomProfile</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomProfile</maml:name> <maml:Description> <maml:para>The custom profile definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomProfile</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomProfile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CapacityConsumer = Initialize-VcfOpsCapacityConsumer -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" $ProfileMetric = Initialize-VcfOpsProfileMetric -Metric "MyMetric" -Value 0 -Unit "MyUnit" $CustomProfile = Initialize-VcfOpsCustomProfile -Id "MyId" -Name "MyName" -Description "MyDescription" -ObjectType $CapacityConsumer -CustomProfileMetrics $ProfileMetric Invoke-VcfOpsCreateCustomProfile -customProfile $customProfile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCustomProfile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CapacityConsumer = Initialize-VcfOpsCapacityConsumer -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" $ProfileMetric = Initialize-VcfOpsProfileMetric -Metric "MyMetric" -Value 0 -Unit "MyUnit" $CustomProfile = Initialize-VcfOpsCustomProfile -Name "MyName" -ObjectType $CapacityConsumer -CustomProfileMetrics $ProfileMetric Invoke-VcfOpsCreateCustomProfile -customProfile $customProfile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateCustomProfile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/profiles/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscustomprofile</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-VcfOpsCreateResourceUsingAdapterInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateResourceUsingAdapterInstance</command:noun> <maml:description> <maml:para>Create a new Resource in the system associated with an existing adapter instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The API will create the missing Adapter Kind and Resource Kind<br>contained within the ResourceKey of the Resource if they do not exist.<br>The API will return an error if the adapter instance specified does not exist.<br>Additional implementation notes: <br><ul><br><li>When creating a Resource, if the Resource Identifiers that are unique and required<br>are not specified, the API would return an error with HTTP status code of 500<br>and an error message indicating the set of missing Resource Identifiers.<br><li><br>When creating a Resource, if the Resource Identifiers that are unique but not required<br>are not specified, the Resource is created where the uniquely identifying Resource Identifiers<br>that were not specified will have their value as an empty string.<br></ul></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateResourceUsingAdapterInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterInstanceId</maml:name> <maml:Description> <maml:para>The adapter instance 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>Resource</maml:name> <maml:Description> <maml:para>The request object that contains info necessary to create a new resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Resource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>AdapterInstanceId</maml:name> <maml:Description> <maml:para>The adapter instance 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>Resource</maml:name> <maml:Description> <maml:para>The request object that contains info necessary to create a new resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Resource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>VMware.Bindings.Vcf.Ops.Model.Resource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $GeoLocation = Initialize-VcfOpsGeoLocation -Latitude 0 -Longitude 0 $ResourceStatusState = Initialize-VcfOpsResourceStatusState -AdapterInstanceId "MyAdapterInstanceId" -ResourceStatus "NONE" -ResourceState "STOPPED" -StatusMessage "MyStatusMessage" $Badge = Initialize-VcfOpsBadge -Type "ANOMALY" -Color "GREEN" -Score 0 $Resource = Initialize-VcfOpsResource -Description "MyDescription" -CreationTime 0 -ResourceKey $ResourceKey -CredentialInstanceId "MyCredentialInstanceId" -GeoLocation $GeoLocation -ResourceStatusStates $ResourceStatusState -ResourceHealth "GREEN" -ResourceHealthValue 0 -DtEnabled $false -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -Badges $Badge -RelatedResources "MyRelatedResources" -Extension $Extension -Links $Link -Identifier "MyIdentifier" Invoke-VcfOpsCreateResourceUsingAdapterInstance -adapterInstanceId "adapterInstanceId_example" -resource $resource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateResourceUsingAdapterInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $ResourceStatusState = Initialize-VcfOpsResourceStatusState $Resource = Initialize-VcfOpsResource -CreationTime 0 -ResourceKey $ResourceKey -ResourceStatusStates $ResourceStatusState -ResourceHealth "GREEN" -ResourceHealthValue 0 Invoke-VcfOpsCreateResourceUsingAdapterInstance -adapterInstanceId "adapterInstanceId_example" -resource $resource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateResourceUsingAdapterInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/adapters/adapterInstanceId/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresource</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-VcfOpsCreateResourceUsingAdapterKind</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateResourceUsingAdapterKind</command:noun> <maml:description> <maml:para>Create a new Resource in the system associated with the specified adapter kind</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This adapter kind (referred to as 'Push' adapter kind) will be created if it does not<br>exist in the system and an instance of it will be associated with the Resource being created.<br>This adapter kind if it already exists must of <i>OPENAPI</i> adapter kind type.<br>The API will also create the missing Adapter Kind and Resource Kind<br>contained within the ResourceKey of the Resource if they do not exist.<br><p><br>Additional implementation notes:<br><ul><br><li>When creating a Resource, if the Resource Identifiers that are unique and required<br>are not specified, the API would return an error with HTTP status code of 500<br>and an error message indicating the set of missing Resource Identifiers.<br><li><br>When creating a Resource, if the Resource Identifiers that are unique but not required<br>are not specified, the Resource is created where the uniquely identifying Resource Identifiers<br>that were not specified will have their value as an empty string.<br></ul></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateResourceUsingAdapterKind</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The adapter kind 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>Resource</maml:name> <maml:Description> <maml:para>The request object that contains info necessary to create a new resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Resource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>AdapterKindKey</maml:name> <maml:Description> <maml:para>The adapter kind 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>Resource</maml:name> <maml:Description> <maml:para>The request object that contains info necessary to create a new resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Resource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>VMware.Bindings.Vcf.Ops.Model.Resource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $GeoLocation = Initialize-VcfOpsGeoLocation -Latitude 0 -Longitude 0 $ResourceStatusState = Initialize-VcfOpsResourceStatusState -AdapterInstanceId "MyAdapterInstanceId" -ResourceStatus "NONE" -ResourceState "STOPPED" -StatusMessage "MyStatusMessage" $Badge = Initialize-VcfOpsBadge -Type "ANOMALY" -Color "GREEN" -Score 0 $Resource = Initialize-VcfOpsResource -Description "MyDescription" -CreationTime 0 -ResourceKey $ResourceKey -CredentialInstanceId "MyCredentialInstanceId" -GeoLocation $GeoLocation -ResourceStatusStates $ResourceStatusState -ResourceHealth "GREEN" -ResourceHealthValue 0 -DtEnabled $false -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -Badges $Badge -RelatedResources "MyRelatedResources" -Extension $Extension -Links $Link -Identifier "MyIdentifier" Invoke-VcfOpsCreateResourceUsingAdapterKind -adapterKindKey "adapterKindKey_example" -resource $resource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateResourceUsingAdapterKind with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $ResourceStatusState = Initialize-VcfOpsResourceStatusState $Resource = Initialize-VcfOpsResource -CreationTime 0 -ResourceKey $ResourceKey -ResourceStatusStates $ResourceStatusState -ResourceHealth "GREEN" -ResourceHealthValue 0 Invoke-VcfOpsCreateResourceUsingAdapterKind -adapterKindKey "adapterKindKey_example" -resource $resource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateResourceUsingAdapterKind with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/adapterkinds/adapterKindKey/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresource</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-VcfOpsDeleteCustomDatacenters</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteCustomDatacenters</command:noun> <maml:description> <maml:para>Delete custom datacenters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete custom datacenters.<br><b>NOTE: </b> Deletion of custom datacenters is <em>not synchronous</em>. As a result, <br>the delete operation may not happen immediately. Furthermore, there is no way <br>to track the status of the deletion operation. It is recommended to query back <br>the system and ensure that the resources (datacenters) with given ids are not present any more.<br><b>NOTE: </b> This API is only for custom datacenters deletion. Any invalid or none custom datacenter ids in the request body will be ignored.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteCustomDatacenters</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>Custom datacenter ids</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>Custom datacenter ids</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsDeleteCustomDatacenters -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCustomDatacenters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsDeleteCustomDatacenters -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCustomDatacenters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/customdatacenters/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuuidvalues</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-VcfOpsDeleteCustomGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteCustomGroup</command:noun> <maml:description> <maml:para>Delete a custom group</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE: </b> Method is enabled for user groups only</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteCustomGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>The Identifier of the group</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>GroupId</maml:name> <maml:Description> <maml:para>The Identifier of the group</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteCustomGroup -groupId "groupId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCustomGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteCustomGroup -groupId "groupId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCustomGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/groups/groupId/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-VcfOpsDeleteCustomProfile</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteCustomProfile</command:noun> <maml:description> <maml:para>Delete a custom profile</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a custom profile</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteCustomProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProfileId</maml:name> <maml:Description> <maml:para>The Identifier of the profile</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>ProfileId</maml:name> <maml:Description> <maml:para>The Identifier of the profile</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteCustomProfile -profileId "profileId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCustomProfile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteCustomProfile -profileId "profileId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteCustomProfile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/profiles/profileId/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-VcfOpsDeleteGroupType</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteGroupType</command:noun> <maml:description> <maml:para>Delete the group type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete the group type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteGroupType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>Key of the group type to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Key of the group type to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteGroupType -key "key_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteGroupType with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteGroupType -key "key_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteGroupType with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/groups/types/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-VcfOpsDeleteResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteResources</command:noun> <maml:description> <maml:para>Delete multiple Resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE: </b> Deletion of Resources is <em>not synchronous</em>. As a result, <br/>the delete operation may not happen immediately. Furthermore, there is no way <br/>to track the status of the deletion operation. It is recommended to query back<br/>the system with the resource identifiers and ensure that the system returns a <br/>404 error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>Identifiers of Resources to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UuidValues</maml:name> <maml:Description> <maml:para>Identifiers of Resources to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.UuidValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.UuidValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsDeleteResources -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" Invoke-VcfOpsDeleteResources -uuidValues $uuidValues </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/bulk/delete//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsuuidvalues</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-VcfOpsGetCustomDatacenter</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCustomDatacenter</command:noun> <maml:description> <maml:para>Get custom datacenter by id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get custom datacenter by id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCustomDatacenter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Custom datacenter 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>Custom datacenter 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>VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCustomDatacenter -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomDatacenter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCustomDatacenter -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomDatacenter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/customdatacenters/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-VcfOpsGetCustomDatacenters</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCustomDatacenters</command:noun> <maml:description> <maml:para>Get custom datacenters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get custom datacenters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCustomDatacenters</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomDatacenters</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCustomDatacenters -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomDatacenters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCustomDatacenters </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomDatacenters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/customdatacenters/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-VcfOpsGetCustomGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCustomGroup</command:noun> <maml:description> <maml:para>Get custom group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a custom group with or without policy</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCustomGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Group identifier</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>IncludePolicy</maml:name> <maml:Description> <maml:para>Flag that controls the retrieval of policy identifier applied to group</maml:para> </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>GroupId</maml:name> <maml:Description> <maml:para>Group identifier</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>IncludePolicy</maml:name> <maml:Description> <maml:para>Flag that controls the retrieval of policy identifier applied to group</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.CustomGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCustomGroup -groupId "groupId_example" -includePolicy $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCustomGroup -groupId "groupId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/groups/groupId/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-VcfOpsGetCustomGroupMembers</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCustomGroupMembers</command:noun> <maml:description> <maml:para>Get members of the group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get members of the specified group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCustomGroupMembers</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Group identifier</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>GroupId</maml:name> <maml:Description> <maml:para>Group identifier</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>VMware.Bindings.Vcf.Ops.Model.Resources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCustomGroupMembers -groupId "groupId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomGroupMembers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCustomGroupMembers -groupId "groupId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomGroupMembers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/groups/groupId/members/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-VcfOpsGetCustomGroups</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCustomGroups</command:noun> <maml:description> <maml:para>Get all custom groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all custom groups with or without policy</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCustomGroups</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Collection of group identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>IncludePolicy</maml:name> <maml:Description> <maml:para>Flag that controls the retrieval of policy identifier applied to group</maml:para> </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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Collection of group identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>IncludePolicy</maml:name> <maml:Description> <maml:para>Flag that controls the retrieval of policy identifier applied to group</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.Cgroups</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCustomGroups -groupId "MygroupId" -includePolicy $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomGroups with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCustomGroups </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomGroups with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/groups/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-VcfOpsGetCustomProfile</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCustomProfile</command:noun> <maml:description> <maml:para>Get custom profile</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get custom profile</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCustomProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ProfileId</maml:name> <maml:Description> <maml:para>The Profile identifier</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>ProfileId</maml:name> <maml:Description> <maml:para>The Profile identifier</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>VMware.Bindings.Vcf.Ops.Model.CustomProfile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCustomProfile -profileId "profileId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomProfile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCustomProfile -profileId "profileId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomProfile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/profiles/profileId/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-VcfOpsGetCustomProfiles</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCustomProfiles</command:noun> <maml:description> <maml:para>Get all custom profiles</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all custom profiles</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCustomProfiles</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomProfiles</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCustomProfiles </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomProfiles with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCustomProfiles </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCustomProfiles with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/profiles/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-VcfOpsGetGroupTypes</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetGroupTypes</command:noun> <maml:description> <maml:para>Get group types</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Group Types</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetGroupTypes</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.GroupTypes</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetGroupTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetGroupTypes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetGroupTypes </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetGroupTypes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/groups/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-VcfOpsGetLatestStatsOfResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetLatestStatsOfResources</command:noun> <maml:description> <maml:para>Get Latest stats of one or more Resources using the query spec that is specified</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>Takes the form:</b> <br><code>api/resources/stats/latest?resourceId=UUID1&resourceId=UUID2</code> <b>OR</b><br><code>api/resources/stats/latest?resourceId=UUID2&statKey=cpu|usagemhz&statKey=cpu|demandmhz</code><br></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetLatestStatsOfResources</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the latest stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the latest stats should be returned</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>MaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest stats.<br>Defaults to 1 so that when processing the query if it is omitted<br>the response would contain a single sample</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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the latest stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the latest stats should be returned</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>MaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest stats.<br>Defaults to 1 so that when processing the query if it is omitted<br>the response would contain a single sample</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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.StatsOfResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetLatestStatsOfResources -resourceId "MyresourceId" -statKey "MystatKey" -metrics $true -currentOnly $true -maxSamples 56 -wrapStatValues $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLatestStatsOfResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetLatestStatsOfResources </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetLatestStatsOfResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/stats/latest/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-VcfOpsGetMatchingResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetMatchingResources</command:noun> <maml:description> <maml:para>Gets a listing of resources based on the query spec specified</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a listing of resources based on the query spec specified</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetMatchingResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceQuery</maml:name> <maml:Description> <maml:para>Query spec that encapsulates various filtering criteria for looking up Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceQuery</maml:name> <maml:Description> <maml:para>Query spec that encapsulates various filtering criteria for looking up Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Resources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag Invoke-VcfOpsGetMatchingResources -resourceQuery $resourceQuery -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetMatchingResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceQuery = Initialize-VcfOpsResourceQuery Invoke-VcfOpsGetMatchingResources -resourceQuery $resourceQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetMatchingResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcequery</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-VcfOpsGetResourcePropertiesList</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourcePropertiesList</command:noun> <maml:description> <maml:para>Get all the Properties and their current (latest) values for the specified Resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all the Properties and their current (latest) values for the specified Resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourcePropertiesList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>The Collection of the Resource Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceId</maml:name> <maml:Description> <maml:para>The Collection of the Resource Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>VMware.Bindings.Vcf.Ops.Model.ResourceProperties</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResourcePropertiesList -resourceId "MyresourceId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcePropertiesList with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResourcePropertiesList -resourceId "MyresourceId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcePropertiesList with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/properties/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-VcfOpsGetResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResources</command:noun> <maml:description> <maml:para>Get a listing of resources based on the query spec specified</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a listing of resources based on the query spec specified</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResources</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Array of resource names to query for.<br><b>NOTE:</b> Currently, only single element supported</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>Regex</maml:name> <maml:Description> <maml:para>Array of resource names in java regex format.<br><b>NOTE:</b> <i>regex</i> and <i>name</i> are mutually exclusive. If both are specified, <i>name</i> is given preference.</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>AdapterKind</maml:name> <maml:Description> <maml:para>Array of Adapter Kind keys</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>ResourceKind</maml:name> <maml:Description> <maml:para>Array of Resource Kind keys</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>CollectorName</maml:name> <maml:Description> <maml:para>Array of Collector 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>Array of Collector Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>MaintenanceScheduleId</maml:name> <maml:Description> <maml:para>Array of {@link UUID} that identify Maintenance Schedules.<br>Since vROps 6.1.0 release onwards, we don't support search<br>and look up of Resources using Maintenance Schedules' identifiers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterInstanceId</maml:name> <maml:Description> <maml:para>Array of uuids that identify adapter instances</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RecentlyAdded</maml:name> <maml:Description> <maml:para>Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.</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>ResourceState</maml:name> <maml:Description> <maml:para>Array of resource states. <b>NOTE</b>, the following states are applicable only for adapter instances: STOPPED, STARTING, STOPPING, UPDATING, FAILED, REMOVING</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceState></command:parameterValue> <dev:type> <maml:name>List<ResourceState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceStatus</maml:name> <maml:Description> <maml:para>Array of resource data collection statuses. <b>NOTE</b>, the following statuses are applicable only for adapter instances: ERROR, DOWN, COLLECTOR_DOWN. The statuses OLD_DATA_RECEIVING, NO_PARENT_MONITORING and UNKNOWN are deprecated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceDataCollectionStatus></command:parameterValue> <dev:type> <maml:name>List<ResourceDataCollectionStatus></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceHealth</maml:name> <maml:Description> <maml:para>Array of resource health</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceHealth></command:parameterValue> <dev:type> <maml:name>List<ResourceHealth></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParentId</maml:name> <maml:Description> <maml:para>Array of UUID of object that are the parent resource in a parent child relationship</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>CredentialId</maml:name> <maml:Description> <maml:para>Array of CredentialIDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>PropertyName</maml:name> <maml:Description> <maml:para>Name of property. Query only supports filtering for a single property.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyValue</maml:name> <maml:Description> <maml:para>Value of property. Omitting the property value will check for existence<br>of the property name on the resource.<br><b>NOTE:</b> Use 'propertyConditions' to specify lookup of Resource using multiple properties.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKey</maml:name> <maml:Description> <maml:para>Name of resource StatKey to validate value is within a range.<br>Use with statKeyLowerBound, statKeyUpperBound and statKeyInclusive to create comparison conditions<br><b>NOTE:</b> Use 'statConditions' to specify lookup of Resource using multiple stat keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyLowerBound</maml:name> <maml:Description> <maml:para>StatKey value matching range lower bound</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double?</command:parameterValue> <dev:type> <maml:name>double?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyUpperBound</maml:name> <maml:Description> <maml:para>StatKey value matching range upper bound</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double?</command:parameterValue> <dev:type> <maml:name>double?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyInclusive</maml:name> <maml:Description> <maml:para>Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeRelated</maml:name> <maml:Description> <maml:para>None null value specifies to include related resource ids of given relationship type in resource result.<br>Uses the RelationshipType.representation value.<br></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>Array of resource names to query for.<br><b>NOTE:</b> Currently, only single element supported</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>Regex</maml:name> <maml:Description> <maml:para>Array of resource names in java regex format.<br><b>NOTE:</b> <i>regex</i> and <i>name</i> are mutually exclusive. If both are specified, <i>name</i> is given preference.</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>AdapterKind</maml:name> <maml:Description> <maml:para>Array of Adapter Kind keys</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>ResourceKind</maml:name> <maml:Description> <maml:para>Array of Resource Kind keys</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>CollectorName</maml:name> <maml:Description> <maml:para>Array of Collector 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>Array of Collector Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>MaintenanceScheduleId</maml:name> <maml:Description> <maml:para>Array of {@link UUID} that identify Maintenance Schedules.<br>Since vROps 6.1.0 release onwards, we don't support search<br>and look up of Resources using Maintenance Schedules' identifiers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterInstanceId</maml:name> <maml:Description> <maml:para>Array of uuids that identify adapter instances</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RecentlyAdded</maml:name> <maml:Description> <maml:para>Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.</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>ResourceState</maml:name> <maml:Description> <maml:para>Array of resource states. <b>NOTE</b>, the following states are applicable only for adapter instances: STOPPED, STARTING, STOPPING, UPDATING, FAILED, REMOVING</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceState></command:parameterValue> <dev:type> <maml:name>List<ResourceState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceStatus</maml:name> <maml:Description> <maml:para>Array of resource data collection statuses. <b>NOTE</b>, the following statuses are applicable only for adapter instances: ERROR, DOWN, COLLECTOR_DOWN. The statuses OLD_DATA_RECEIVING, NO_PARENT_MONITORING and UNKNOWN are deprecated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceDataCollectionStatus></command:parameterValue> <dev:type> <maml:name>List<ResourceDataCollectionStatus></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceHealth</maml:name> <maml:Description> <maml:para>Array of resource health</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ResourceHealth></command:parameterValue> <dev:type> <maml:name>List<ResourceHealth></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParentId</maml:name> <maml:Description> <maml:para>Array of UUID of object that are the parent resource in a parent child relationship</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>CredentialId</maml:name> <maml:Description> <maml:para>Array of CredentialIDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>PropertyName</maml:name> <maml:Description> <maml:para>Name of property. Query only supports filtering for a single property.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyValue</maml:name> <maml:Description> <maml:para>Value of property. Omitting the property value will check for existence<br>of the property name on the resource.<br><b>NOTE:</b> Use 'propertyConditions' to specify lookup of Resource using multiple properties.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKey</maml:name> <maml:Description> <maml:para>Name of resource StatKey to validate value is within a range.<br>Use with statKeyLowerBound, statKeyUpperBound and statKeyInclusive to create comparison conditions<br><b>NOTE:</b> Use 'statConditions' to specify lookup of Resource using multiple stat keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyLowerBound</maml:name> <maml:Description> <maml:para>StatKey value matching range lower bound</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double?</command:parameterValue> <dev:type> <maml:name>double?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyUpperBound</maml:name> <maml:Description> <maml:para>StatKey value matching range upper bound</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double?</command:parameterValue> <dev:type> <maml:name>double?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyInclusive</maml:name> <maml:Description> <maml:para>Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeRelated</maml:name> <maml:Description> <maml:para>None null value specifies to include related resource ids of given relationship type in resource result.<br>Uses the RelationshipType.representation value.<br></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Resources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetResources -name "Myname" -regex "Myregex" -adapterKind "MyadapterKind" -resourceKind "MyresourceKind" -collectorName "MycollectorName" -collectorId 0 -maintenanceScheduleId "MymaintenanceScheduleId" -adapterInstanceId "MyadapterInstanceId" -recentlyAdded 789L -resourceState "STOPPED" -resourceStatus "NONE" -resourceHealth "GREEN" -parentId "MyparentId" -credentialId "MycredentialId" -resourceId "MyresourceId" -propertyName "propertyName_example" -propertyValue "propertyValue_example" -statKey "statKey_example" -statKeyLowerBound 1.2D -statKeyUpperBound 1.2D -statKeyInclusive $true -includeRelated "PARENT" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetResources </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/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-VcfOpsGetResourcesRelationships</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetResourcesRelationships</command:noun> <maml:description> <maml:para>Get resources that satisfy filtering criteria and are related to specified list of resources with the given relationship type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get resources that satisfy filtering criteria and are related to specified listof resources with the given relationship type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetResourcesRelationships</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceRelationshipsQuery</maml:name> <maml:Description> <maml:para>Query spec that encapsulates various filtering criteria for related resources look up</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceRelationshipsQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceRelationshipsQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceRelationshipsQuery</maml:name> <maml:Description> <maml:para>Query spec that encapsulates various filtering criteria for related resources look up</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceRelationshipsQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceRelationshipsQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesRelation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $ResourceRelationshipsQuery = Initialize-VcfOpsResourceRelationshipsQuery -RelationshipType "PARENT" -ResourceIds "MyResourceIds" -ResourceQuery $ResourceQuery -HierarchyDepth 0 Invoke-VcfOpsGetResourcesRelationships -resourceRelationshipsQuery $resourceRelationshipsQuery -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesRelationships with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceRelationshipsQuery = Initialize-VcfOpsResourceRelationshipsQuery -RelationshipType "PARENT" -ResourceIds "MyResourceIds" Invoke-VcfOpsGetResourcesRelationships -resourceRelationshipsQuery $resourceRelationshipsQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetResourcesRelationships with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/bulk/relationships/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcerelationshipsquery</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-VcfOpsGetStatKeysOfResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetStatKeysOfResources</command:noun> <maml:description> <maml:para>Get all the available stat keys and their details for the specified resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>Sample URI: </b><br><code>/api/resources/statkeys?resourceId=UUID1</code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetStatKeysOfResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>The identifiers of the Resources</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>Searchstring</maml:name> <maml:Description> <maml:para>An optional wildcard search string that allows<br>user to refine the list of returned Stat Key details by<br>key name. Usage is similar to a LIKE \"<tt>%searchstring%</tt>\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ResourceId</maml:name> <maml:Description> <maml:para>The identifiers of the Resources</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>Searchstring</maml:name> <maml:Description> <maml:para>An optional wildcard search string that allows<br>user to refine the list of returned Stat Key details by<br>key name. Usage is similar to a LIKE \"<tt>%searchstring%</tt>\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatKeys</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetStatKeysOfResources -resourceId "resourceId_example" -searchstring "searchstring_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatKeysOfResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetStatKeysOfResources -resourceId "resourceId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatKeysOfResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/statkeys/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-VcfOpsGetStatsAndDTForResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetStatsAndDTForResources</command:noun> <maml:description> <maml:para>Get Stats and Dynamic Threshold values for one or more StatKeys and for a Collection of Resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The API returns 24 hours of Stats and DT data by default for the specified Resources.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetStatsAndDTForResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DtStatQuery</maml:name> <maml:Description> <maml:para>The object which specifies the search criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.DtStatQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.DtStatQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DtStatQuery</maml:name> <maml:Description> <maml:para>The object which specifies the search criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.DtStatQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.DtStatQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatsOfResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DtStatQuery = Initialize-VcfOpsDtStatQuery -ResourceIds "MyResourceIds" -StatKeys "MyStatKeys" -Begin 0 -End 0 -ShowSmooth $false -SmoothFactor 0 Invoke-VcfOpsGetStatsAndDTForResources -dtStatQuery $dtStatQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsAndDTForResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DtStatQuery = Initialize-VcfOpsDtStatQuery -ResourceIds "MyResourceIds" -StatKeys "MyStatKeys" Invoke-VcfOpsGetStatsAndDTForResources -dtStatQuery $dtStatQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsAndDTForResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/stats/dt/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsdtstatquery</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-VcfOpsGetStatsForResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetStatsForResources</command:noun> <maml:description> <maml:para>Get stats for one or more Resources using the specific query spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get stats for one or more Resources using the specific query spec</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetStatsForResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatQuery</maml:name> <maml:Description> <maml:para>The object which specifies the search criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatQuery</maml:name> <maml:Description> <maml:para>The object which specifies the search criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatsOfResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatQuery = Initialize-VcfOpsStatQuery -ResourceId "MyResourceId" -StatKey "MyStatKey" -Begin 0 -End 0 -RollUpType "SUM" -IntervalType "HOURS" -IntervalQuantifier 0 -Dt $false -LatestMaxSamples 0 -Metrics $false -CurrentOnly $false -WrapStatValues $false Invoke-VcfOpsGetStatsForResources -statQuery $statQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsForResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StatQuery = Initialize-VcfOpsStatQuery Invoke-VcfOpsGetStatsForResources -statQuery $statQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsForResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/stats/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsstatquery</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-VcfOpsGetStatsOfResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetStatsOfResources</command:noun> <maml:description> <maml:para>Get stats for one or more Resources using the specific query spec</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is a <i>GET</i> endpoint and the query parameters control the data that is retrieved.<br>If the number of Resources for which one needs to query data is large, it is recommended to<br>use the <code>POST /api/stats/query</code> endpoint to avoid the URL length limitations.<br><b>Takes the form:</b><br><code>api/resources/stats?resourceId=UUID1</code> <b>OR</b><br><code>api/resources/stats?resourceId=UUID2&statKey=cpu|usagemhz&rollUpType=&begin=&end=</code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetStatsOfResources</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>Rollup Type requested by the user (e.g.: AVG, MIN, MAX 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>IntervalType</maml:name> <maml:Description> <maml:para>Interval type requested by the user (e.g: Days, Weeks, Months 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>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>Rollup Type requested by the user (e.g.: AVG, MIN, MAX 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>IntervalType</maml:name> <maml:Description> <maml:para>Interval type requested by the user (e.g: Days, Weeks, Months 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>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.StatsOfResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetStatsOfResources -resourceId "MyresourceId" -statKey "MystatKey" -begin 789L -end 789L -rollUpType "SUM" -intervalType "HOURS" -intervalQuantifier 56 -dt $true -latestMaxSamples 56 -metrics $true -currentOnly $true -wrapStatValues $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsOfResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetStatsOfResources </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetStatsOfResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/stats/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-VcfOpsGetTopNStatsOfResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetTopNStatsOfResources</command:noun> <maml:description> <maml:para>Get the Top-N stats data for one or more Resources and a set of StatKeys</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Top-N stats data for one or more Resources and a set of StatKeys</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetTopNStatsOfResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TopN</maml:name> <maml:Description> <maml:para>The number of results. Keep in mind if a grouping contains multiple items (eg:<br>grouped by resource, with 4 metrics for the grouping resource) then returning the group with<br>4 metrics counts as 4 topN entries. If there are not enough remaining open topN entries to<br>return an entire group within the topN then the entire group is not returned. *</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>GroupBy</maml:name> <maml:Description> <maml:para>The type of grouping, if not set defaults to ResourceStatGroupBy.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>SortOrder</maml:name> <maml:Description> <maml:para>The type of sorting, if not set defaults to ResourceStatSort.ASCENDING</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>Rollup Type requested by the user (e.g.: AVG, MIN, MAX 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>IntervalType</maml:name> <maml:Description> <maml:para>Interval type requested by the user (e.g: Days, Weeks, Months 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>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>TopN</maml:name> <maml:Description> <maml:para>The number of results. Keep in mind if a grouping contains multiple items (eg:<br>grouped by resource, with 4 metrics for the grouping resource) then returning the group with<br>4 metrics counts as 4 topN entries. If there are not enough remaining open topN entries to<br>return an entire group within the topN then the entire group is not returned. *</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>GroupBy</maml:name> <maml:Description> <maml:para>The type of grouping, if not set defaults to ResourceStatGroupBy.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>SortOrder</maml:name> <maml:Description> <maml:para>The type of sorting, if not set defaults to ResourceStatSort.ASCENDING</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>End</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>Rollup Type requested by the user (e.g.: AVG, MIN, MAX 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>IntervalType</maml:name> <maml:Description> <maml:para>Interval type requested by the user (e.g: Days, Weeks, Months 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>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>VMware.Bindings.Vcf.Ops.Model.ResourceStatGroupList</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetTopNStatsOfResources -topN 56 -groupBy "RESOURCE" -sortOrder "ASCENDING" -resourceId "MyresourceId" -statKey "MystatKey" -begin 789L -end 789L -rollUpType "SUM" -intervalType "HOURS" -intervalQuantifier 56 -dt $true -latestMaxSamples 56 -metrics $true -currentOnly $true -wrapStatValues $true </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTopNStatsOfResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetTopNStatsOfResources -topN 56 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTopNStatsOfResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/stats/topn/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-VcfOpsMarkResourcesAsBeingMaintained</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsMarkResourcesAsBeingMaintained</command:noun> <maml:description> <maml:para>Put all the specified Resource in Maintenance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Resources can end up in two maintenance states - <i>MAINTAINED</i> OR <i>MAINTAINED_MANUAL</i> -<br>depending upon the inputs specified.<br/><br><ul><br><li>If duration/end time is specified, the Resources will be placed in <i>MAINTAINED</i><br>state and after the duration/end time expires, the state of the Resources would be automatically<br>set to the state they were in before entering the maintenance window.<br><li>If duration/end time is not specified, the Resources will be placed in <i>MAINTAINED_MANUAL</i> state.<br>Callers have to execute <code>DELETE /suite-api/api/resources/maintained?id=ID1&id=ID2</code> API<br>to set the Resources back to whatever state they were in.<br><li>If both duration and end time are specified, end time takes preference over duration.<br></ul></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsMarkResourcesAsBeingMaintained</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Duration</maml:name> <maml:Description> <maml:para>The Duration for which this resource will be in maintenance (In Minutes)</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>End</maml:name> <maml:Description> <maml:para>The End time of the maintenance window as a long value (Epoch time)</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>The Resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Duration</maml:name> <maml:Description> <maml:para>The Duration for which this resource will be in maintenance (In Minutes)</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>End</maml:name> <maml:Description> <maml:para>The End time of the maintenance window as a long value (Epoch time)</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-VcfOpsMarkResourcesAsBeingMaintained -id "Myid" -duration 56 -end 789L </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsMarkResourcesAsBeingMaintained with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsMarkResourcesAsBeingMaintained -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsMarkResourcesAsBeingMaintained with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/maintained/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-VcfOpsModifyCustomGroup</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsModifyCustomGroup</command:noun> <maml:description> <maml:para>Modify an existing custom group definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para><b>NOTE: </b> Method is enabled for user groups only</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsModifyCustomGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomGroup</maml:name> <maml:Description> <maml:para>The custom group definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomGroup</maml:name> <maml:Description> <maml:para>The custom group definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomGroup</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $CustomGroupProperty = Initialize-VcfOpsCustomGroupProperty -Name "MyName" -Type "STRING" -InclusionValue "MyInclusionValue" -ExclusionValue "MyExclusionValue" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $PropertyStatConditionRule = Initialize-VcfOpsPropertyStatConditionRule -Key "MyKey" -StringValue "MyStringValue" -DoubleValue 0 -CompareOperator "EQ" $ResourceNameConditionRule = Initialize-VcfOpsResourceNameConditionRule -Name "MyName" -CompareOperator "EQ" $RelationshipConditionRule = Initialize-VcfOpsRelationshipConditionRule -Relation "PARENT" -Name "MyName" -CompareOperator "EQ" -TravesalSpecId "MyTravesalSpecId" $ResourceTagConditionRule = Initialize-VcfOpsResourceTagConditionRule -Category "MyCategory" -CompareOperator "EQ" -StringValue "MyStringValue" $MembershipRuleGroup = Initialize-VcfOpsMembershipRuleGroup -ResourceKindKey $ResourceKindKey -StatConditionRules $PropertyStatConditionRule -PropertyConditionRules $PropertyStatConditionRule -ResourceNameConditionRules $ResourceNameConditionRule -RelationshipConditionRules $RelationshipConditionRule -ResourceTagConditionRules $ResourceTagConditionRule $CustomGroupMembership = Initialize-VcfOpsCustomGroupMembership -IncludedResources "MyIncludedResources" -ExcludedResources "MyExcludedResources" -CustomGroupProperties $CustomGroupProperty -Rules $MembershipRuleGroup $CustomGroup = Initialize-VcfOpsCustomGroup -Id "MyId" -ResourceKey $ResourceKey -Policy "MyPolicy" -AutoResolveMembership $false -MembershipDefinition $CustomGroupMembership -Links $Link Invoke-VcfOpsModifyCustomGroup -customGroup $customGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyCustomGroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $CustomGroupMembership = Initialize-VcfOpsCustomGroupMembership $CustomGroup = Initialize-VcfOpsCustomGroup -ResourceKey $ResourceKey -MembershipDefinition $CustomGroupMembership Invoke-VcfOpsModifyCustomGroup -customGroup $customGroup </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyCustomGroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/groups/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscustomgroup</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-VcfOpsModifyCustomProfile</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsModifyCustomProfile</command:noun> <maml:description> <maml:para>Modify an existing custom profile definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Modify an existing custom profile definition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsModifyCustomProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomProfile</maml:name> <maml:Description> <maml:para>The custom profile definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomProfile</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomProfile</maml:name> <maml:Description> <maml:para>The custom profile definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomProfile</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomProfile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CapacityConsumer = Initialize-VcfOpsCapacityConsumer -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" $ProfileMetric = Initialize-VcfOpsProfileMetric -Metric "MyMetric" -Value 0 -Unit "MyUnit" $CustomProfile = Initialize-VcfOpsCustomProfile -Id "MyId" -Name "MyName" -Description "MyDescription" -ObjectType $CapacityConsumer -CustomProfileMetrics $ProfileMetric Invoke-VcfOpsModifyCustomProfile -customProfile $customProfile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyCustomProfile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CapacityConsumer = Initialize-VcfOpsCapacityConsumer -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" $ProfileMetric = Initialize-VcfOpsProfileMetric -Metric "MyMetric" -Value 0 -Unit "MyUnit" $CustomProfile = Initialize-VcfOpsCustomProfile -Name "MyName" -ObjectType $CapacityConsumer -CustomProfileMetrics $ProfileMetric Invoke-VcfOpsModifyCustomProfile -customProfile $customProfile </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsModifyCustomProfile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/profiles/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscustomprofile</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-VcfOpsQueryLatestPropertiesOfResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsQueryLatestPropertiesOfResources</command:noun> <maml:description> <maml:para>Get current (latest) values of requested properties for the specified resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get current (latest) values of requested properties for the specified resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsQueryLatestPropertiesOfResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertiesQuery</maml:name> <maml:Description> <maml:para>The query spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PropertiesQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PropertiesQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertiesQuery</maml:name> <maml:Description> <maml:para>The query spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PropertiesQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PropertiesQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourcesPropertyContents</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PropertiesQuery = Initialize-VcfOpsPropertiesQuery -ResourceIds "MyResourceIds" -PropertyKeys "MyPropertyKeys" -Instanced $false Invoke-VcfOpsQueryLatestPropertiesOfResources -propertiesQuery $propertiesQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryLatestPropertiesOfResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PropertiesQuery = Initialize-VcfOpsPropertiesQuery -ResourceIds "MyResourceIds" -PropertyKeys "MyPropertyKeys" Invoke-VcfOpsQueryLatestPropertiesOfResources -propertiesQuery $propertiesQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryLatestPropertiesOfResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/properties/latest/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspropertiesquery</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-VcfOpsQueryLatestStatsOfResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsQueryLatestStatsOfResources</command:noun> <maml:description> <maml:para>Get the last \"maxSamples\" stats values for specified one or more Resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the last \"maxSamples\" stats values for specified one or more Resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsQueryLatestStatsOfResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LatestStatQuery</maml:name> <maml:Description> <maml:para>The object which specifies the search criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.LatestStatQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LatestStatQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LatestStatQuery</maml:name> <maml:Description> <maml:para>The object which specifies the search criteria</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.LatestStatQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LatestStatQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatsOfResources</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LatestStatQuery = Initialize-VcfOpsLatestStatQuery -ResourceId "MyResourceId" -StatKey "MyStatKey" -Metrics $false -CurrentOnly $false -MaxSamples 0 -WrapStatValues $false Invoke-VcfOpsQueryLatestStatsOfResources -latestStatQuery $latestStatQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryLatestStatsOfResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LatestStatQuery = Initialize-VcfOpsLatestStatQuery Invoke-VcfOpsQueryLatestStatsOfResources -latestStatQuery $latestStatQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQueryLatestStatsOfResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/stats/latest/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpslateststatquery</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-VcfOpsStartMonitoringResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsStartMonitoringResources</command:noun> <maml:description> <maml:para>Inform one or more or all Adapters to start monitoring a Collection of Resources. Note: Start isn't supported on per resource bases any more.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The query parameter <i>id</i> is for specifying the set of Resources that should<br>be monitored.<br>The optional query parameter <i>adapterId</i> determines which of the<br>Adapters need to be informed to start monitoring the Resources. If this is<br>not specified, then all of the Adapters will start monitoring the specified Resources.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsStartMonitoringResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifiers that need to be monitored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterId</maml:name> <maml:Description> <maml:para>Collection of adapter instance identifiers that should start monitoring the Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>The Resource identifiers that need to be monitored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterId</maml:name> <maml:Description> <maml:para>Collection of adapter instance identifiers that should start monitoring the Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsStartMonitoringResources -id "Myid" -adapterId "MyadapterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStartMonitoringResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsStartMonitoringResources -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStartMonitoringResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/monitoringstate/start/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-VcfOpsStopMonitoringResources</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsStopMonitoringResources</command:noun> <maml:description> <maml:para>Inform one or more or all Adapters to stop monitoring a Collection of Resources. Note: Stop isn't supported on per resource bases any more.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The query parameter <i>id</i> is for specifying the set of Resources that should<br>no longer be monitored.<br>The optional query parameter <i>adapterId</i> determines which of the<br>Adapters need to be informed to stop monitoring the Resources. If this is<br>not specified, then all of the Adapters will stop monitoring the specified Resources.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsStopMonitoringResources</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Resource identifiers that no longer need to be monitored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterId</maml:name> <maml:Description> <maml:para>Collection of adapter instance identifiers that should stop monitoring the Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>The Resource identifiers that no longer need to be monitored</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterId</maml:name> <maml:Description> <maml:para>Collection of adapter instance identifiers that should stop monitoring the Resources</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsStopMonitoringResources -id "Myid" -adapterId "MyadapterId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStopMonitoringResources with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsStopMonitoringResources -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsStopMonitoringResources with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/monitoringstate/stop/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-VcfOpsUnmarkResourcesAsBeingMaintained</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUnmarkResourcesAsBeingMaintained</command:noun> <maml:description> <maml:para>Bring the specified set of Resources out of Maintenance manually</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Bring the specified set of Resources out of Maintenance manually</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUnmarkResourcesAsBeingMaintained</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>A collection of Resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>A collection of Resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsUnmarkResourcesAsBeingMaintained -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnmarkResourcesAsBeingMaintained with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsUnmarkResourcesAsBeingMaintained -id "Myid" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUnmarkResourcesAsBeingMaintained with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/maintained/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-VcfOpsUpdateCustomDatacenter</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateCustomDatacenter</command:noun> <maml:description> <maml:para>Update a custom datacenter</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a custom datacenter</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateCustomDatacenter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomDatacenter</maml:name> <maml:Description> <maml:para>Custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomDatacenter</maml:name> <maml:Description> <maml:para>Custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomDatacenter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CustomDatacenter = Initialize-VcfOpsCustomDatacenter -Id "MyId" -Name "MyName" -Description "MyDescription" -ChildResourceIds "MyChildResourceIds" Invoke-VcfOpsUpdateCustomDatacenter -customDatacenter $customDatacenter </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateCustomDatacenter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CustomDatacenter = Initialize-VcfOpsCustomDatacenter -Name "MyName" -ChildResourceIds "MyChildResourceIds" Invoke-VcfOpsUpdateCustomDatacenter -customDatacenter $customDatacenter </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateCustomDatacenter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/customdatacenters/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscustomdatacenter</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-VcfOpsUpdateResource</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateResource</command:noun> <maml:description> <maml:para>Update a Resource in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para><p><br>Implementation Notes: <br/><br><ul><br><li>When updating a Resource, if the Resource Identifiers that are unique and required<br>are not specified, the API would return an error with HTTP status code of 500<br>and an error message indicating the set of missing Resource Identifiers.<br><li><br>When updating a Resource, if the Resource Identifiers that are unique but not required<br>are not specified, the Resource is updated where the uniquely identifying Resource Identifiers<br>that were not specified will have their value as an empty string.<br></ul></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Resource</maml:name> <maml:Description> <maml:para>The Resource object that needs to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Resource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>Resource</maml:name> <maml:Description> <maml:para>The Resource object that needs to be updated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Resource</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>VMware.Bindings.Vcf.Ops.Model.Resource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $GeoLocation = Initialize-VcfOpsGeoLocation -Latitude 0 -Longitude 0 $ResourceStatusState = Initialize-VcfOpsResourceStatusState -AdapterInstanceId "MyAdapterInstanceId" -ResourceStatus "NONE" -ResourceState "STOPPED" -StatusMessage "MyStatusMessage" $Badge = Initialize-VcfOpsBadge -Type "ANOMALY" -Color "GREEN" -Score 0 $Resource = Initialize-VcfOpsResource -Description "MyDescription" -CreationTime 0 -ResourceKey $ResourceKey -CredentialInstanceId "MyCredentialInstanceId" -GeoLocation $GeoLocation -ResourceStatusStates $ResourceStatusState -ResourceHealth "GREEN" -ResourceHealthValue 0 -DtEnabled $false -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -Badges $Badge -RelatedResources "MyRelatedResources" -Extension $Extension -Links $Link -Identifier "MyIdentifier" Invoke-VcfOpsUpdateResource -resource $resource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateResource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $ResourceStatusState = Initialize-VcfOpsResourceStatusState $Resource = Initialize-VcfOpsResource -CreationTime 0 -ResourceKey $ResourceKey -ResourceStatusStates $ResourceStatusState -ResourceHealth "GREEN" -ResourceHealthValue 0 Invoke-VcfOpsUpdateResource -resource $resource </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateResource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/resources/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresource</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-VcfOpsGetAdapterKindsForSolution</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetAdapterKindsForSolution</command:noun> <maml:description> <maml:para>Get Adapter Kind details for the specified solution id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Adapter Kind details for the specified solution id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetAdapterKindsForSolution</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SolutionId</maml:name> <maml:Description> <maml:para>The id of the solution</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>SolutionId</maml:name> <maml:Description> <maml:para>The id of the solution</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AdapterKinds</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetAdapterKindsForSolution -solutionId "solutionId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterKindsForSolution with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetAdapterKindsForSolution -solutionId "solutionId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetAdapterKindsForSolution with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/solutions/solutionId/adapterkinds/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-VcfOpsGetSolution</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetSolution</command:noun> <maml:description> <maml:para>Get solution data for the specified id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Data includes name, version, vendor and adapterKinds of the solution</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetSolution</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SolutionId</maml:name> <maml:Description> <maml:para>The Id of the solution</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>SolutionId</maml:name> <maml:Description> <maml:para>The Id of the solution</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Solution</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetSolution -solutionId "solutionId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSolution with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetSolution -solutionId "solutionId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSolution with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/solutions/solutionId/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-VcfOpsGetSolutions</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetSolutions</command:noun> <maml:description> <maml:para>Get all solutions installed in the product</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get data about all the solutions associated with VMware Cloud Foundation Operations instance. Data includes name, version , vendor and adapterKinds of the solution.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetSolutions</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Solutions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetSolutions </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSolutions with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetSolutions </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSolutions with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/solutions/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-VcfOpsCreateSuperMetric</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateSuperMetric</command:noun> <maml:description> <maml:para>Create a SuperMetric with the given name, formula and description</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a SuperMetric with the given name, formula and description</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateSuperMetric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Supermetric</maml:name> <maml:Description> <maml:para>The SuperMetric to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Supermetric</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Supermetric</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Supermetric</maml:name> <maml:Description> <maml:para>The SuperMetric to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Supermetric</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Supermetric</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Supermetric</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Supermetric = Initialize-VcfOpsSupermetric -Id "MyId" -Name "MyName" -Formula "MyFormula" -Description "MyDescription" -ModificationTime 0 Invoke-VcfOpsCreateSuperMetric -supermetric $supermetric </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateSuperMetric with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Supermetric = Initialize-VcfOpsSupermetric -Name "MyName" -Formula "MyFormula" Invoke-VcfOpsCreateSuperMetric -supermetric $supermetric </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateSuperMetric with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/supermetrics/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpssupermetric</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-VcfOpsDeleteSuperMetric</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteSuperMetric</command:noun> <maml:description> <maml:para>Delete a SuperMetric</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a SuperMetric</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteSuperMetric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the SuperMetric to delete</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>The Identifier of the SuperMetric to delete</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteSuperMetric -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteSuperMetric with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteSuperMetric -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteSuperMetric with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/supermetrics/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-VcfOpsGetSuperMetric</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetSuperMetric</command:noun> <maml:description> <maml:para>Get a SuperMetric with the given id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a SuperMetric with the given ID</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetSuperMetric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Identifier of the SuperMetric</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>The Identifier of the SuperMetric</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>VMware.Bindings.Vcf.Ops.Model.Supermetric</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetSuperMetric -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSuperMetric with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetSuperMetric -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSuperMetric with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/supermetrics/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-VcfOpsGetSuperMetrics</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetSuperMetrics</command:noun> <maml:description> <maml:para>Get a collection of SuperMetrics based on search parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a collection of SuperMetrics based on search parameters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetSuperMetrics</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>SuperMetrics based on identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Name</maml:name> <maml:Description> <maml:para>SuperMetrics based on 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>SuperMetrics based on identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Name</maml:name> <maml:Description> <maml:para>SuperMetrics based on 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Supermetrics</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetSuperMetrics -id "Myid" -name "Myname" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSuperMetrics with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetSuperMetrics </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSuperMetrics with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/supermetrics/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-VcfOpsUpdateSuperMetric</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateSuperMetric</command:noun> <maml:description> <maml:para>Update a SuperMetric with the given name, formula and description</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a SuperMetric with the given name, formula and description</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateSuperMetric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Supermetric</maml:name> <maml:Description> <maml:para>The updated SuperMetric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Supermetric</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Supermetric</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Supermetric</maml:name> <maml:Description> <maml:para>The updated SuperMetric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Supermetric</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Supermetric</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Supermetric</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Supermetric = Initialize-VcfOpsSupermetric -Id "MyId" -Name "MyName" -Formula "MyFormula" -Description "MyDescription" -ModificationTime 0 Invoke-VcfOpsUpdateSuperMetric -supermetric $supermetric </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateSuperMetric with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Supermetric = Initialize-VcfOpsSupermetric -Name "MyName" -Formula "MyFormula" Invoke-VcfOpsUpdateSuperMetric -supermetric $supermetric </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateSuperMetric with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/supermetrics/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpssupermetric</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-VcfOpsCreateSymptomDefinition</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsCreateSymptomDefinition</command:noun> <maml:description> <maml:para>Create the Symptom Definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The symptom definition identifier must be null and will be generated by the system.<br>A symptom definition contains a symptom state, there may only be one symptom state per symptom definition.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsCreateSymptomDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomDefinition</maml:name> <maml:Description> <maml:para>The Symptom Definition to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomDefinition</maml:name> <maml:Description> <maml:para>The Symptom Definition to create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$OneOfCondition = Initialize-VcfOpsOneOfCondition $SymptomState = Initialize-VcfOpsSymptomState -Severity "UNKNOWN" -Condition $OneOfCondition $SymptomDefinition = Initialize-VcfOpsSymptomDefinition -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -WaitCycles 0 -CancelCycles 0 -RealtimeMonitoringEnabled $false -State $SymptomState Invoke-VcfOpsCreateSymptomDefinition -symptomDefinition $symptomDefinition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateSymptomDefinition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfCondition = Initialize-VcfOpsOneOfCondition $SymptomState = Initialize-VcfOpsSymptomState -Severity "UNKNOWN" -Condition $OneOfCondition $SymptomDefinition = Initialize-VcfOpsSymptomDefinition -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -State $SymptomState Invoke-VcfOpsCreateSymptomDefinition -symptomDefinition $symptomDefinition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsCreateSymptomDefinition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/symptomdefinitions/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpssymptomdefinition</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-VcfOpsDeleteSymptomDefinition</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsDeleteSymptomDefinition</command:noun> <maml:description> <maml:para>Delete a Symptom Definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a Symptom Definition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsDeleteSymptomDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the Symptom Definition to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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 identifier of the Symptom Definition to delete</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsDeleteSymptomDefinition -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteSymptomDefinition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsDeleteSymptomDefinition -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsDeleteSymptomDefinition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/symptomdefinitions/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-VcfOpsGetSymptomDefinitionByKey</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetSymptomDefinitionByKey</command:noun> <maml:description> <maml:para>Get Symptom Definition specified by id</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get Symptom Definition specified by id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetSymptomDefinitionByKey</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 Symptom Definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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 Symptom Definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetSymptomDefinitionByKey -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSymptomDefinitionByKey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetSymptomDefinitionByKey -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSymptomDefinitionByKey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/symptomdefinitions/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-VcfOpsGetSymptomDefinitions</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetSymptomDefinitions</command:noun> <maml:description> <maml:para>Get Symptom Definitions</maml:para> </maml:description> </command:details> <maml:description> <maml:para><i><b>NOTE:</b></i> When making an XML request, make sure the <i>statKey</i> field does not contain any key name with spaces.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetSymptomDefinitions</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind identifier of the symptom definitions to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind identifier of the symptom definitions to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier(s) of the symptom definitions to search for. Exact match.</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>Name</maml:name> <maml:Description> <maml:para>The substring of the symptom definition's name to search for. Case-insensitive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind identifier of the symptom definitions to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind identifier of the symptom definitions to search for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier(s) of the symptom definitions to search for. Exact match.</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>Name</maml:name> <maml:Description> <maml:para>The substring of the symptom definition's name to search for. Case-insensitive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomDefinitions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetSymptomDefinitions -adapterKind "adapterKind_example" -resourceKind "resourceKind_example" -id "Myid" -name "name_example" -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSymptomDefinitions with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetSymptomDefinitions </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSymptomDefinitions with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/symptomdefinitions/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-VcfOpsGetSymptoms</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetSymptoms</command:noun> <maml:description> <maml:para>Look up all Symptoms in the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Optionally these Symptoms can be looked up for a specific set of Resources and/or <br/>can include Symptoms that are no longer active.<br/>The list of Symptoms returned is a collection that supports pagination.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetSymptoms</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Array of resource identifiers for which Symptoms need to be looked up</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ActiveOnly</maml:name> <maml:Description> <maml:para>Boolean that determines whether the results should include inactive Symptoms</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeAlarmInfo</maml:name> <maml:Description> <maml:para>Boolean that controls the retrieval of alarm information of the symptom</maml:para> </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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</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>Array of resource identifiers for which Symptoms need to be looked up</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ActiveOnly</maml:name> <maml:Description> <maml:para>Boolean that determines whether the results should include inactive Symptoms</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeAlarmInfo</maml:name> <maml:Description> <maml:para>Boolean that controls the retrieval of alarm information of the symptom</maml:para> </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>Page</maml:name> <maml:Description> <maml:para>Page number from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Symptoms</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetSymptoms -resourceId "MyresourceId" -activeOnly $true -includeAlarmInfo $false -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSymptoms with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetSymptoms </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSymptoms with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/symptoms/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-VcfOpsQuerySymptoms</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsQuerySymptoms</command:noun> <maml:description> <maml:para>Look up a set of Symptoms using a query object</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The list of Symptoms returned is a collection that supports pagination.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsQuerySymptoms</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomQuery</maml:name> <maml:Description> <maml:para>Query object of the symptom</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.SymptomQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomQuery</maml:name> <maml:Description> <maml:para>Query object of the symptom</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.SymptomQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 from which data needs to be displayed (0-based)</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PageSize</maml:name> <maml:Description> <maml:para>Expected number of entries per page</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>1000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Symptoms</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag "UNKNOWN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $SymptomQuery = Initialize-VcfOpsSymptomQuery -CompositeOperator "AND" -SymptomId "MySymptomId" -ResourceQuery $ResourceQuery -IncludeChildrenResources $false -ActiveOnly $false -IncludeAlarmInfo $false -AlarmType 0 -AlarmCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag "UNKNOWN" -StartTimeRange $TimeRange -CancelTimeRange $TimeRange -SymptomDefinitionId "MySymptomDefinitionId" -StatKey "MyStatKey" Invoke-VcfOpsQuerySymptoms -symptomQuery $symptomQuery -page 0 -pageSize 1000 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQuerySymptoms with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SymptomQuery = Initialize-VcfOpsSymptomQuery Invoke-VcfOpsQuerySymptoms -symptomQuery $symptomQuery </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsQuerySymptoms with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/symptoms/query/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpssymptomquery</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-VcfOpsUpdateSymptomDefinition</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsUpdateSymptomDefinition</command:noun> <maml:description> <maml:para>Update an existing Symptom Definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an existing Symptom Definition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsUpdateSymptomDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomDefinition</maml:name> <maml:Description> <maml:para>The Symptom Definition to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomDefinition</maml:name> <maml:Description> <maml:para>The Symptom Definition to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomDefinition</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$OneOfCondition = Initialize-VcfOpsOneOfCondition $SymptomState = Initialize-VcfOpsSymptomState -Severity "UNKNOWN" -Condition $OneOfCondition $SymptomDefinition = Initialize-VcfOpsSymptomDefinition -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -WaitCycles 0 -CancelCycles 0 -RealtimeMonitoringEnabled $false -State $SymptomState Invoke-VcfOpsUpdateSymptomDefinition -symptomDefinition $symptomDefinition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateSymptomDefinition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfCondition = Initialize-VcfOpsOneOfCondition $SymptomState = Initialize-VcfOpsSymptomState -Severity "UNKNOWN" -Condition $OneOfCondition $SymptomDefinition = Initialize-VcfOpsSymptomDefinition -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -State $SymptomState Invoke-VcfOpsUpdateSymptomDefinition -symptomDefinition $symptomDefinition </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsUpdateSymptomDefinition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/symptomdefinitions/put//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpssymptomdefinition</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-VcfOpsGetTaskStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetTaskStatus</command:noun> <maml:description> <maml:para>Look up a task status with the given identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In general, to get the status of any long running operations, the operation<br>must have been initiated through the VMware Cloud Foundation Operations REST API.<br>This API returns the status of a specific task that was initiated via the REST API <br>with the exception of tasks that get created when any Remediation Action is performed<br>via the <code>api/actions</code> endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetTaskStatus</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 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>Id</maml:name> <maml:Description> <maml:para>The id 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>VMware.Bindings.Vcf.Ops.Model.TaskStatus</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetTaskStatus -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTaskStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetTaskStatus -id "id_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTaskStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/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-VcfOpsGetTasksStatus</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetTasksStatus</command:noun> <maml:description> <maml:para>Look up a list of task objects' statuses</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In general, to get the status of any long running operations, the operation <br>must have been initiated through the VMware Cloud Foundation Operations REST API.<br>This API endpoint returns the details of the long running tasks that were submitted via the API only.<br>Furthermore, the list of tasks that this API returns includes tasks for long running operations such <br>as Adapter Installation, Describe etc. This API does not return the tasks created when any <br>Remediation Actions are executed in the system either via the UI or via the API.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetTasksStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskState</maml:name> <maml:Description> <maml:para>States of the tasks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<TaskState></command:parameterValue> <dev:type> <maml:name>List<TaskState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>The task ids</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<Guid></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>TaskState</maml:name> <maml:Description> <maml:para>States of the tasks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<TaskState></command:parameterValue> <dev:type> <maml:name>List<TaskState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>The task ids</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>VMware.Bindings.Vcf.Ops.Model.TaskStatuses</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetTasksStatus -taskState "INITIATED" -taskId "MytaskId" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTasksStatus with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetTasksStatus </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetTasksStatus with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/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-VcfOpsGetCurrentVersionOfServer</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetCurrentVersionOfServer</command:noun> <maml:description> <maml:para>Get the current version of the service</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the current version of the service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetCurrentVersionOfServer</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Version</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetCurrentVersionOfServer </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCurrentVersionOfServer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetCurrentVersionOfServer </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetCurrentVersionOfServer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/versions/current/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-VcfOpsGetSupportedApplicationVersions</command:name> <command:verb>Invoke</command:verb> <command:noun>VcfOpsGetSupportedApplicationVersions</command:noun> <maml:description> <maml:para>Get all supported versions by the service</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all supported versions by the service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VcfOpsGetSupportedApplicationVersions</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Versions</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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-VcfOpsGetSupportedApplicationVersions </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSupportedApplicationVersions with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VcfOpsGetSupportedApplicationVersions </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VcfOpsGetSupportedApplicationVersions with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-vrealize-operations-api/latest/api/versions/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-VcfOpsactionexecution</command:name> <command:verb>Initialize</command:verb> <command:noun>actionexecution</command:noun> <maml:description> <maml:para>Contains describe instance data about performing an action.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains describe instance data about performing an action.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsactionexecution</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContextId</maml:name> <maml:Description> <maml:para>An optional value naming the action step that will be executed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContextResourceId</maml:name> <maml:Description> <maml:para>The UUID list of resources that the action will be performed against</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ParameterGroup</maml:name> <maml:Description> <maml:para>The parameters that are used as inputs for the action being performed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ActionParameterGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ActionParameterGroup></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>ContextId</maml:name> <maml:Description> <maml:para>An optional value naming the action step that will be executed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContextResourceId</maml:name> <maml:Description> <maml:para>The UUID list of resources that the action will be performed against</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ParameterGroup</maml:name> <maml:Description> <maml:para>The parameters that are used as inputs for the action being performed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ActionParameterGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ActionParameterGroup></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $ActionParameterGroup = Initialize-VcfOpsActionParameterGroup -ResourceId "MyResourceId" -ParameterValue $NameValue $ActionExecution = Initialize-VcfOpsActionExecution -ContextId "MyContextId" -ContextResourceId "MyContextResourceId" -ParameterGroup $ActionParameterGroup </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsactionexecution with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ActionParameterGroup = Initialize-VcfOpsActionParameterGroup -ResourceId "MyResourceId" $ActionExecution = Initialize-VcfOpsActionExecution -ParameterGroup $ActionParameterGroup </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsactionexecution with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ActionExecution</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsactionparametergroup</command:name> <command:verb>Initialize</command:verb> <command:noun>actionparametergroup</command:noun> <maml:description> <maml:para>Contains the resource uuid and parameter values for a method.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains the resource uuid and parameter values for a method.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsactionparametergroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>The resourceId field contains the Resource Id of the object which the action is run against.</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>ParameterValue</maml:name> <maml:Description> <maml:para>Contains the parameter values associated with this resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>The resourceId field contains the Resource Id of the object which the action is run against.</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>ParameterValue</maml:name> <maml:Description> <maml:para>Contains the parameter values associated with this resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $ActionParameterGroup = Initialize-VcfOpsActionParameterGroup -ResourceId "MyResourceId" -ParameterValue $NameValue </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsactionparametergroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ActionParameterGroup = Initialize-VcfOpsActionParameterGroup -ResourceId "MyResourceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsactionparametergroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ActionParameterGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsactionpopulation</command:name> <command:verb>Initialize</command:verb> <command:noun>actionpopulation</command:noun> <maml:description> <maml:para>Contains the additional information about an action needed to populate it. The context resource ids are needed to run the population expression and get default values where defined.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains the additional information about an action needed to populate it. The context resource ids are needed to run the population expression and get default values where defined.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsactionpopulation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContextResourceId</maml:name> <maml:Description> <maml:para>The UUID list of the resources that the population will be run against</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ContextResourceId</maml:name> <maml:Description> <maml:para>The UUID list of the resources that the population will be run against</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ActionPopulation = Initialize-VcfOpsActionPopulation -ContextResourceId "MyContextResourceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsactionpopulation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ActionPopulation = Initialize-VcfOpsActionPopulation -ContextResourceId "MyContextResourceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsactionpopulation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ActionPopulation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsadapterinstance</command:name> <command:verb>Initialize</command:verb> <command:noun>adapterinstance</command:noun> <maml:description> <maml:para>Model object containing information about the adapter instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model object containing information about the adapter instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsadapterinstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKey</maml:name> <maml: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>Optional description of the Adapter 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The ID of the Collector that manages this adapter instance. This is optional and if not specified, system will choose an appropriate collector.</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>CollectorGroupId</maml:name> <maml:Description> <maml:para>The ID of the collector group. If not specified, the system will choose an appropriate Collector group for you</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>CredentialInstanceId</maml:name> <maml:Description> <maml:para>The Credential Instance identifier used by this adapter instance</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>MonitoringInterval</maml:name> <maml:Description> <maml:para>Minutes part of the monitoring Interval of the Adapter Instance.</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>MonitoringIntervalSeconds</maml:name> <maml:Description> <maml:para>Seconds part of the monitoring Interval of the Adapter Instance</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>NumberOfMetricsCollected</maml:name> <maml:Description> <maml:para>The number of metrics reported by this adapter instance.</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>NumberOfResourcesCollected</maml:name> <maml:Description> <maml:para>The number of resources being monitored by this resource.</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>LastHeartbeat</maml:name> <maml:Description> <maml:para>Last time when this adapter instance communicated with VMware Cloud Foundation Operations Server.</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>LastCollected</maml:name> <maml:Description> <maml:para>Last time adapter instance reported collection of resources/stats.</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>MessageFromAdapterInstance</maml:name> <maml:Description> <maml:para>Any message from the adapter 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>AdapterCertificates</maml:name> <maml:Description> <maml:para>The set of untrusted certificates returned by the adapter source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PhysicalDatacenterId</maml:name> <maml:Description> <maml:para>The Physical Datacenter ID to be used for this Adapter Instance.It is Optional</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>Id</maml:name> <maml:Description> <maml:para>The UUID of the adapter instance</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>ResourceKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKey</maml:name> <maml: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>Optional description of the Adapter 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The ID of the Collector that manages this adapter instance. This is optional and if not specified, system will choose an appropriate collector.</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>CollectorGroupId</maml:name> <maml:Description> <maml:para>The ID of the collector group. If not specified, the system will choose an appropriate Collector group for you</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>CredentialInstanceId</maml:name> <maml:Description> <maml:para>The Credential Instance identifier used by this adapter instance</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>MonitoringInterval</maml:name> <maml:Description> <maml:para>Minutes part of the monitoring Interval of the Adapter Instance.</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>MonitoringIntervalSeconds</maml:name> <maml:Description> <maml:para>Seconds part of the monitoring Interval of the Adapter Instance</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>NumberOfMetricsCollected</maml:name> <maml:Description> <maml:para>The number of metrics reported by this adapter instance.</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>NumberOfResourcesCollected</maml:name> <maml:Description> <maml:para>The number of resources being monitored by this resource.</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>LastHeartbeat</maml:name> <maml:Description> <maml:para>Last time when this adapter instance communicated with VMware Cloud Foundation Operations Server.</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>LastCollected</maml:name> <maml:Description> <maml:para>Last time adapter instance reported collection of resources/stats.</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>MessageFromAdapterInstance</maml:name> <maml:Description> <maml:para>Any message from the adapter 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>AdapterCertificates</maml:name> <maml:Description> <maml:para>The set of untrusted certificates returned by the adapter source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PhysicalDatacenterId</maml:name> <maml:Description> <maml:para>The Physical Datacenter ID to be used for this Adapter Instance.It is Optional</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>Id</maml:name> <maml:Description> <maml:para>The UUID of the adapter instance</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AdapterInstance = Initialize-VcfOpsAdapterInstance -ResourceKey $ResourceKey -Description "MyDescription" -CollectorId 0 -CollectorGroupId "MyCollectorGroupId" -CredentialInstanceId "MyCredentialInstanceId" -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -NumberOfMetricsCollected 0 -NumberOfResourcesCollected 0 -LastHeartbeat 0 -LastCollected 0 -MessageFromAdapterInstance "MyMessageFromAdapterInstance" -AdapterCertificates $Certificate -Links $Link -PhysicalDatacenterId "MyPhysicalDatacenterId" -Id "MyId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsadapterinstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $Certificate = Initialize-VcfOpsCertificate $AdapterInstance = Initialize-VcfOpsAdapterInstance -ResourceKey $ResourceKey -AdapterCertificates $Certificate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsadapterinstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AdapterInstance</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcekey</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-VcfOpsadditionalrate</command:name> <command:verb>Initialize</command:verb> <command:noun>additionalrate</command:noun> <maml:description> <maml:para>Model representing additional rate</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing additional rate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsadditionalrate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UsageLowerBound</maml:name> <maml:Description> <maml:para>Lowest threshold for applying the rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Rate applied above the threshold</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</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>UsageLowerBound</maml:name> <maml:Description> <maml:para>Lowest threshold for applying the rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Rate applied above the threshold</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AdditionalRate = Initialize-VcfOpsAdditionalRate -UsageLowerBound 0 -Rate 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsadditionalrate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AdditionalRate = Initialize-VcfOpsAdditionalRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsadditionalrate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AdditionalRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsalertcondition</command:name> <command:verb>Initialize</command:verb> <command:noun>alertcondition</command:noun> <maml:description> <maml:para>The alert's condition is a product of the severity and a condition.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The alert's condition is a product of the severity and a condition.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsalertcondition</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 condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WaitCycles</maml:name> <maml:Description> <maml:para>The number of consecutive cycles to wait when a symptom state is true before a symptom is triggered</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>CancelCycles</maml:name> <maml:Description> <maml:para>The number of consecutive cycles to wait when a symptom state is false before a symptom is cancelled</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>Severity</maml:name> <maml:Description> <maml:para>The Criticality level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Condition</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfCondition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfCondition</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 condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WaitCycles</maml:name> <maml:Description> <maml:para>The number of consecutive cycles to wait when a symptom state is true before a symptom is triggered</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>CancelCycles</maml:name> <maml:Description> <maml:para>The number of consecutive cycles to wait when a symptom state is false before a symptom is cancelled</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>Severity</maml:name> <maml:Description> <maml:para>The Criticality level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Condition</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfCondition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfCondition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $OneOfCondition = Initialize-VcfOpsOneOfCondition $AlertCondition = Initialize-VcfOpsAlertCondition -Id "MyId" -WaitCycles 0 -CancelCycles 0 -Severity "UNKNOWN" -Condition $OneOfCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertcondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $OneOfCondition = Initialize-VcfOpsOneOfCondition $AlertCondition = Initialize-VcfOpsAlertCondition -Severity "UNKNOWN" -Condition $OneOfCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertcondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertCondition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsOneOfCondition</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-VcfOpsalertdefinition</command:name> <command:verb>Initialize</command:verb> <command:noun>alertdefinition</command:noun> <maml:description> <maml:para>Defines a Problem by associating the Criticality level (<b><i>Criticality</i></b>)<br>of Symptom Definitions on related objects in the <b><i>AlertDefinitionState</i></b><br>and also associates to a particular impact (<b><i>AlertDefinitionImpact</i></b>)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Defines a Problem by associating the Criticality level (<b><i>Criticality</i></b>)<br>of Symptom Definitions on related objects in the <b><i>AlertDefinitionState</i></b><br>and also associates to a particular impact (<b><i>AlertDefinitionImpact</i></b>)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsalertdefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The unique identifier across the system. Must be null during create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Problem Definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the problem definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The adapter kind key of the Adapter Kind that the Alert Definition applies 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The resource kind key for the Resource Kind that the Alert Definition applies 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WaitCycles</maml:name> <maml:Description> <maml:para>The Number of cycles the symptom conditions are true before triggering the problem alert</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>CancelCycles</maml:name> <maml:Description> <maml:para>The Number of cycles the symptom conditions are false before ending the problem alert</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>Type</maml:name> <maml:Description> <maml:para>The type of the problem, for the purposes of routing an alert generated<br>by this problem.</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>SubType</maml:name> <maml:Description> <maml:para>The sub type of the problem, for the purposes of routing an alert<br>generated by this problem.</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>States</maml:name> <maml:Description> <maml:para>An Alert Definition state identifies the severity and impact a problem has when the<br>set of Symptom Definition conditions are true. One Alert Definition state per severity.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.AlertDefinitionState></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.AlertDefinitionState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForVCDTenants</maml:name> <maml:Description> <maml:para>Is alert definition for tenants 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>Id</maml:name> <maml:Description> <maml:para>The unique identifier across the system. Must be null during create</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Problem Definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the problem definition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The adapter kind key of the Adapter Kind that the Alert Definition applies 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The resource kind key for the Resource Kind that the Alert Definition applies 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WaitCycles</maml:name> <maml:Description> <maml:para>The Number of cycles the symptom conditions are true before triggering the problem alert</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>CancelCycles</maml:name> <maml:Description> <maml:para>The Number of cycles the symptom conditions are false before ending the problem alert</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>Type</maml:name> <maml:Description> <maml:para>The type of the problem, for the purposes of routing an alert generated<br>by this problem.</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>SubType</maml:name> <maml:Description> <maml:para>The sub type of the problem, for the purposes of routing an alert<br>generated by this problem.</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>States</maml:name> <maml:Description> <maml:para>An Alert Definition state identifies the severity and impact a problem has when the<br>set of Symptom Definition conditions are true. One Alert Definition state per severity.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.AlertDefinitionState></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.AlertDefinitionState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ForVCDTenants</maml:name> <maml:Description> <maml:para>Is alert definition for tenants 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> $OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet $AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" $AlertDefinitionState = Initialize-VcfOpsAlertDefinitionState -Severity "UNKNOWN" -BaseSymptomSet $OneOfSymptomSet -Impact $AlertDefinitionImpact -RecommendationPriorityMap @{ key_example = 0 } $AlertDefinition = Initialize-VcfOpsAlertDefinition -Id "MyId" -Name "MyName" -Description "MyDescription" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -WaitCycles 0 -CancelCycles 0 -Type 0 -SubType 0 -States $AlertDefinitionState -ForVCDTenants $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertdefinition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet $AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" $AlertDefinitionState = Initialize-VcfOpsAlertDefinitionState -Severity "UNKNOWN" -BaseSymptomSet $OneOfSymptomSet -Impact $AlertDefinitionImpact $AlertDefinition = Initialize-VcfOpsAlertDefinition -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -States $AlertDefinitionState </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertdefinition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsalertdefinitionimpact</command:name> <command:verb>Initialize</command:verb> <command:noun>alertdefinitionimpact</command:noun> <maml:description> <maml:para>The alert's impact on the system</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The alert's impact on the system</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsalertdefinitionimpact</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ImpactType</maml:name> <maml:Description> <maml:para>The type of impact a problem has on the system, or how it is reported</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Detail</maml:name> <maml:Description> <maml:para>Details for the type of impact</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ImpactType</maml:name> <maml:Description> <maml:para>The type of impact a problem has on the system, or how it is reported</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Detail</maml:name> <maml:Description> <maml:para>Details for the type of impact</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertdefinitionimpact with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertdefinitionimpact with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertDefinitionImpact</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsalertdefinitionquery</command:name> <command:verb>Initialize</command:verb> <command:noun>alertdefinitionquery</command:noun> <maml:description> <maml:para>Parameters used to search for Alert Definitions.<br>Search for system defined Alert Definitions via <i>adapterKinds</i> and <i>resourceKinds</i> or search for user-defined Alert Definitions via their identifiers</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Parameters used to search for Alert Definitions.<br>Search for system defined Alert Definitions via <i>adapterKinds</i> and <i>resourceKinds</i> or search for user-defined Alert Definitions via their identifiers</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsalertdefinitionquery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Ids</maml:name> <maml:Description> <maml:para>The identifier(s) of the Alert Definitions to search for.<br>Do not specify <i>adapterKind</i> or <i>resourceKind</i> if searching by 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>AdapterKinds</maml:name> <maml:Description> <maml:para>List of adapter kind keys. Can only be used when adapterKind is empty</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>ResourceKinds</maml:name> <maml:Description> <maml:para>List of resource kind keys. Can only be used when resourceKind is empty</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>Ids</maml:name> <maml:Description> <maml:para>The identifier(s) of the Alert Definitions to search for.<br>Do not specify <i>adapterKind</i> or <i>resourceKind</i> if searching by 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>AdapterKinds</maml:name> <maml:Description> <maml:para>List of adapter kind keys. Can only be used when adapterKind is empty</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>ResourceKinds</maml:name> <maml:Description> <maml:para>List of resource kind keys. Can only be used when resourceKind is empty</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>$AlertDefinitionQuery = Initialize-VcfOpsAlertDefinitionQuery -Ids "MyIds" -AdapterKinds "MyAdapterKinds" -ResourceKinds "MyResourceKinds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertdefinitionquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertDefinitionQuery = Initialize-VcfOpsAlertDefinitionQuery </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertdefinitionquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertDefinitionQuery</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsalertdefinitionstate</command:name> <command:verb>Initialize</command:verb> <command:noun>alertdefinitionstate</command:noun> <maml:description> <maml:para>The problem state describes the severity of a problem when specific symptoms exist on related resources. It optionally may include a prioritized recommendation list.<br>The Symptom Set can be either a {@link SymptomSet} or {@link CompositeSymptomSet}.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The problem state describes the severity of a problem when specific symptoms exist on related resources. It optionally may include a prioritized recommendation list.<br>The Symptom Set can be either a {@link SymptomSet} or {@link CompositeSymptomSet}.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsalertdefinitionstate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Severity</maml:name> <maml:Description> <maml:para>The Criticality level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseSymptomSet</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfSymptomSet</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfSymptomSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Impact</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertDefinitionImpact</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinitionImpact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RecommendationPriorityMap</maml:name> <maml:Description> <maml:para>A map of recommendation identifiers keyed by recommendation id. A lower<br>priority value indicates higher priority. The priorities are required to<br>start from 1.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, int></command:parameterValue> <dev:type> <maml:name>Dictionary<string, 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>Severity</maml:name> <maml:Description> <maml:para>The Criticality level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseSymptomSet</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfSymptomSet</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfSymptomSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Impact</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertDefinitionImpact</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertDefinitionImpact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RecommendationPriorityMap</maml:name> <maml:Description> <maml:para>A map of recommendation identifiers keyed by recommendation id. A lower<br>priority value indicates higher priority. The priorities are required to<br>start from 1.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Dictionary<string, int></command:parameterValue> <dev:type> <maml:name>Dictionary<string, 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> $OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet $AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" $AlertDefinitionState = Initialize-VcfOpsAlertDefinitionState -Severity "UNKNOWN" -BaseSymptomSet $OneOfSymptomSet -Impact $AlertDefinitionImpact -RecommendationPriorityMap @{ key_example = 0 } </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertdefinitionstate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet $AlertDefinitionImpact = Initialize-VcfOpsAlertDefinitionImpact -ImpactType "BADGE" -Detail "MyDetail" $AlertDefinitionState = Initialize-VcfOpsAlertDefinitionState -Severity "UNKNOWN" -BaseSymptomSet $OneOfSymptomSet -Impact $AlertDefinitionImpact </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertdefinitionstate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertDefinitionState</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsOneOfSymptomSet</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertdefinitionimpact</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-VcfOpsalertnotecontent</command:name> <command:verb>Initialize</command:verb> <command:noun>alertnotecontent</command:noun> <maml:description> <maml:para>The note content for creating an alert note</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The note content for creating an alert note</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsalertnotecontent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The alert note content</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Content</maml:name> <maml:Description> <maml:para>The alert note content</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AlertNoteContent = Initialize-VcfOpsAlertNoteContent -Content "MyContent" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertnotecontent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertNoteContent = Initialize-VcfOpsAlertNoteContent -Content "MyContent" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertnotecontent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertNoteContent</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsalertnotesquery</command:name> <command:verb>Initialize</command:verb> <command:noun>alertnotesquery</command:noun> <maml:description> <maml:para>Query for alert notes by various criteria.<br>Composition of filtering criteria controlled via the <i>compositeOperator</i> property.<br>For Pagination see <i>PageInfo</i> <br>For sorting see <i>AlertNoteField</i> and <i>SortOrder</i> enumerations. <br>If a sort field is not specified but pagination is requested the Alert notes will be<br>sorted by the <b><i>alertNoteId</i></b> field.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Query for alert notes by various criteria.<br>Composition of filtering criteria controlled via the <i>compositeOperator</i> property.<br>For Pagination see <i>PageInfo</i> <br>For sorting see <i>AlertNoteField</i> and <i>SortOrder</i> enumerations. <br>If a sort field is not specified but pagination is requested the Alert notes will be<br>sorted by the <b><i>alertNoteId</i></b> field.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsalertnotesquery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompositeOperator</maml:name> <maml:Description> <maml:para>Operations for Composite Conditions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertNoteId</maml:name> <maml:Description> <maml:para>Filter based on Alert Note identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AlertQuery</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml: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>Filter based on user 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertNoteType</maml:name> <maml:Description> <maml:para>Filter based on alert note types</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<AlertNotesQuery.AlertNoteTypeEnum></command:parameterValue> <dev:type> <maml:name>List<AlertNotesQuery.AlertNoteTypeEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>Filter based on note contents</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>CompositeOperator</maml:name> <maml:Description> <maml:para>Operations for Composite Conditions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertNoteId</maml:name> <maml:Description> <maml:para>Filter based on Alert Note identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AlertQuery</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AlertQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AlertQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CreationTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml: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>Filter based on user 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertNoteType</maml:name> <maml:Description> <maml:para>Filter based on alert note types</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<AlertNotesQuery.AlertNoteTypeEnum></command:parameterValue> <dev:type> <maml:name>List<AlertNotesQuery.AlertNoteTypeEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>Filter based on note contents</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> $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $AlertQuery = Initialize-VcfOpsAlertQuery -CompositeOperator "AND" -AlertId "MyAlertId" -AlertName "MyAlertName" -ResourceQuery $ResourceQuery -ActiveOnly $false -AlertTypeSubtype $AlertTypeMapping -AlertCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN" -AlertStatus $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW" -AlertImpact "MyAlertImpact" -AlertDefinitionId "MyAlertDefinitionId" -AlertControlState $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN" -StartTimeRange $TimeRange -UpdateTimeRange $TimeRange -CancelTimeRange $TimeRange -IncludeChildrenResources $false -ExtractOwnerName $false -UserId "MyUserId" -UserName "MyUserName" -ResourceKind "MyResourceKind" -GroupingCondition "GROUP_BY_ALERT_DEFINITION" -GroupId "MyGroupId" "SYSTEM"$AlertNotesQuery = Initialize-VcfOpsAlertNotesQuery -CompositeOperator "AND" -AlertNoteId "MyAlertNoteId" -AlertQuery $AlertQuery -CreationTimeRange $TimeRange -UserName "MyUserName" -AlertNoteType $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $AlertQuery = Initialize-VcfOpsAlertQuery -CompositeOperator "AND" -AlertId "MyAlertId" -AlertName "MyAlertName" -ResourceQuery $ResourceQuery -ActiveOnly $false -AlertTypeSubtype $AlertTypeMapping -AlertCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN" -AlertStatus $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW" -AlertImpact "MyAlertImpact" -AlertDefinitionId "MyAlertDefinitionId" -AlertControlState $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN" -StartTimeRange $TimeRange -UpdateTimeRange $TimeRange -CancelTimeRange $TimeRange -IncludeChildrenResources $false -ExtractOwnerName $false -UserId "MyUserId" -UserName "MyUserName" -ResourceKind "MyResourceKind" -GroupingCondition "GROUP_BY_ALERT_DEFINITION" -GroupId "MyGroupId" "SYSTEM" -Content "MyContent" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertnotesquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $AlertQuery = Initialize-VcfOpsAlertQuery $AlertNotesQuery = Initialize-VcfOpsAlertNotesQuery -AlertQuery $AlertQuery </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertnotesquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertNotesQuery</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsalertquery</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstimerange</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-VcfOpsalertquery</command:name> <command:verb>Initialize</command:verb> <command:noun>alertquery</command:noun> <maml:description> <maml:para>Query for alerts by various criteria.<br>Composition of filtering criteria controlled via the <i>compositeOperator</i> property.<br>For Pagination see <i>PageInfo</i> <br>For sorting see <i>AlertField</i> and <i>SortOrder</i> enumerations. <br>If a sort field is not specified but pagination is requested the Alerts will be<br>sorted by the <b><i>alertId</i></b> field.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Query for alerts by various criteria.<br>Composition of filtering criteria controlled via the <i>compositeOperator</i> property.<br>For Pagination see <i>PageInfo</i> <br>For sorting see <i>AlertField</i> and <i>SortOrder</i> enumerations. <br>If a sort field is not specified but pagination is requested the Alerts will be<br>sorted by the <b><i>alertId</i></b> field.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsalertquery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompositeOperator</maml:name> <maml:Description> <maml:para>Operations for Composite Conditions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertId</maml:name> <maml:Description> <maml:para>Filter based on Alert identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AlertName</maml:name> <maml:Description> <maml:para>Filter based on Alert name using 'contains' logic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceQuery</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActiveOnly</maml:name> <maml:Description> <maml:para>Filter to return only Active alerts, if true, the query will exclude Suspended and Cancelled Alerts</maml:para> </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>AlertTypeSubtype</maml:name> <maml:Description> <maml:para>Filter based on Alert Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.AlertTypeMapping></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.AlertTypeMapping></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertCriticality</maml:name> <maml:Description> <maml:para>Filter based on Alert Criticality</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<AlertQuery.AlertCriticalityEnum></command:parameterValue> <dev:type> <maml:name>List<AlertQuery.AlertCriticalityEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertStatus</maml:name> <maml:Description> <maml:para>Filter based on the Alert Status. If looking for only active alerts combined<br>with other filter criteria then use the <b><i>activeOnly</i></b> property instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<AlertQuery.AlertStatusEnum></command:parameterValue> <dev:type> <maml:name>List<AlertQuery.AlertStatusEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertImpact</maml:name> <maml:Description> <maml:para>Filter based on the Alert Impact</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>AlertDefinitionId</maml:name> <maml:Description> <maml:para>Filter based on the Alert definition id</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>AlertControlState</maml:name> <maml:Description> <maml:para>Filter based on the Alert Control State</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<AlertQuery.AlertControlStateEnum></command:parameterValue> <dev:type> <maml:name>List<AlertQuery.AlertControlStateEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpdateTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CancelTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeChildrenResources</maml:name> <maml:Description> <maml:para>True to include alerts generated by child resources</maml:para> </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>ExtractOwnerName</maml:name> <maml:Description> <maml:para>Indicates whether need to report alert owner's name in addition to owner's id</maml:para> </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>UserId</maml:name> <maml:Description> <maml:para>Filter based on 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserName</maml:name> <maml:Description> <maml:para>Filter based on user name using 'contains' logic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>Filter based on resource kind using 'contains' logic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupingCondition</maml:name> <maml:Description> <maml:para>Indicates the alert grouping condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Filter based on alert group id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>CompositeOperator</maml:name> <maml:Description> <maml:para>Operations for Composite Conditions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertId</maml:name> <maml:Description> <maml:para>Filter based on Alert identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AlertName</maml:name> <maml:Description> <maml:para>Filter based on Alert name using 'contains' logic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceQuery</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActiveOnly</maml:name> <maml:Description> <maml:para>Filter to return only Active alerts, if true, the query will exclude Suspended and Cancelled Alerts</maml:para> </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>AlertTypeSubtype</maml:name> <maml:Description> <maml:para>Filter based on Alert Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.AlertTypeMapping></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.AlertTypeMapping></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertCriticality</maml:name> <maml:Description> <maml:para>Filter based on Alert Criticality</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<AlertQuery.AlertCriticalityEnum></command:parameterValue> <dev:type> <maml:name>List<AlertQuery.AlertCriticalityEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertStatus</maml:name> <maml:Description> <maml:para>Filter based on the Alert Status. If looking for only active alerts combined<br>with other filter criteria then use the <b><i>activeOnly</i></b> property instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<AlertQuery.AlertStatusEnum></command:parameterValue> <dev:type> <maml:name>List<AlertQuery.AlertStatusEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertImpact</maml:name> <maml:Description> <maml:para>Filter based on the Alert Impact</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>AlertDefinitionId</maml:name> <maml:Description> <maml:para>Filter based on the Alert definition id</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>AlertControlState</maml:name> <maml:Description> <maml:para>Filter based on the Alert Control State</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<AlertQuery.AlertControlStateEnum></command:parameterValue> <dev:type> <maml:name>List<AlertQuery.AlertControlStateEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UpdateTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CancelTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeChildrenResources</maml:name> <maml:Description> <maml:para>True to include alerts generated by child resources</maml:para> </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>ExtractOwnerName</maml:name> <maml:Description> <maml:para>Indicates whether need to report alert owner's name in addition to owner's id</maml:para> </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>UserId</maml:name> <maml:Description> <maml:para>Filter based on 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserName</maml:name> <maml:Description> <maml:para>Filter based on user name using 'contains' logic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>Filter based on resource kind using 'contains' logic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupingCondition</maml:name> <maml:Description> <maml:para>Indicates the alert grouping condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupId</maml:name> <maml:Description> <maml:para>Filter based on alert group id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $AlertQuery = Initialize-VcfOpsAlertQuery -CompositeOperator "AND" -AlertId "MyAlertId" -AlertName "MyAlertName" -ResourceQuery $ResourceQuery -ActiveOnly $false -AlertTypeSubtype $AlertTypeMapping -AlertCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN" -AlertStatus $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW" -AlertImpact "MyAlertImpact" -AlertDefinitionId "MyAlertDefinitionId" -AlertControlState $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 "UNKNOWN""NEW""OPEN" -StartTimeRange $TimeRange -UpdateTimeRange $TimeRange -CancelTimeRange $TimeRange -IncludeChildrenResources $false -ExtractOwnerName $false -UserId "MyUserId" -UserName "MyUserName" -ResourceKind "MyResourceKind" -GroupingCondition "GROUP_BY_ALERT_DEFINITION" -GroupId "MyGroupId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $AlertQuery = Initialize-VcfOpsAlertQuery </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsalertquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertQuery</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcequery</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstimerange</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstimerange</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstimerange</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-VcfOpsAlertTypeFilter</command:name> <command:verb>Initialize</command:verb> <command:noun>AlertTypeFilter</command:noun> <maml:description> <maml:para>Represents an alert type filter</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents an alert type filter</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsAlertTypeFilter</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertType</maml:name> <maml:Description> <maml:para>Type of the alert</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>AlertSubTypes</maml:name> <maml:Description> <maml:para>Sub Types of the alert</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>AlertType</maml:name> <maml:Description> <maml:para>Type of the alert</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>AlertSubTypes</maml:name> <maml:Description> <maml:para>Sub Types of the alert</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>$AlertTypeFilter = Initialize-VcfOpsAlertTypeFilter -AlertType 0 -AlertSubTypes 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsAlertTypeFilter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertTypeFilter = Initialize-VcfOpsAlertTypeFilter </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsAlertTypeFilter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertTypeFilter</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsAlertTypeMapping</command:name> <command:verb>Initialize</command:verb> <command:noun>AlertTypeMapping</command:noun> <maml:description> <maml:para>Filter based on Alert Type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Filter based on Alert Type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsAlertTypeMapping</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>No description available.</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>Subtype</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>Type</maml:name> <maml:Description> <maml:para>No description available.</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>Subtype</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>$AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 -Subtype 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsAlertTypeMapping with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AlertTypeMapping = Initialize-VcfOpsAlertTypeMapping -Type 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsAlertTypeMapping with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AlertTypeMapping</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsapplicationservicelist</command:name> <command:verb>Initialize</command:verb> <command:noun>applicationservicelist</command:noun> <maml:description> <maml:para>Model that represents the event of bulk plugin activation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents the event of bulk plugin activation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsapplicationservicelist</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetIds</maml:name> <maml:Description> <maml:para>VM or Endpoint or EC2Instance Resource UUIDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Services</maml:name> <maml:Description> <maml:para>Application service configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationsParameters></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationsParameters></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetIds</maml:name> <maml:Description> <maml:para>VM or Endpoint or EC2Instance Resource UUIDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Services</maml:name> <maml:Description> <maml:para>Application service configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationsParameters></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationsParameters></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $KeyValue = Initialize-VcfOpsKeyValue -Key "MyKey" -Value "MyValue" $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -IsActivated $false -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServiceList = Initialize-VcfOpsApplicationServiceList -TargetIds "MyTargetIds" -Services $ServiceConfigurationsParameters </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsapplicationservicelist with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $KeyValue = Initialize-VcfOpsKeyValue $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServiceList = Initialize-VcfOpsApplicationServiceList -TargetIds "MyTargetIds" -Services $ServiceConfigurationsParameters </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsapplicationservicelist with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ApplicationServiceList</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsapplicationservices</command:name> <command:verb>Initialize</command:verb> <command:noun>applicationservices</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-VcfOpsapplicationservices</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Services</maml:name> <maml:Description> <maml:para>Collection of applications service configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationsParameters></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationsParameters></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Services</maml:name> <maml:Description> <maml:para>Collection of applications service configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationsParameters></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationsParameters></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $KeyValue = Initialize-VcfOpsKeyValue -Key "MyKey" -Value "MyValue" $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -IsActivated $false -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServices = Initialize-VcfOpsApplicationServices -Services $ServiceConfigurationsParameters </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsapplicationservices with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $KeyValue = Initialize-VcfOpsKeyValue $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration $ApplicationServices = Initialize-VcfOpsApplicationServices -Services $ServiceConfigurationsParameters </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsapplicationservices with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ApplicationServices</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsauthsource</command:name> <command:verb>Initialize</command:verb> <command:noun>authsource</command:noun> <maml:description> <maml:para>Besides local users, VMware Cloud Foundation Operations also allows users from external systems such as <b>LDAP, Active Directory, VC, SSO</b> to<br>login using their original credentials. Authentication of all such users are delegated to external systems. This<br>model represents a single auth source managed by VMware Cloud Foundation Operations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Besides local users, VMware Cloud Foundation Operations also allows users from external systems such as <b>LDAP, Active Directory, VC, SSO</b> to<br>login using their original credentials. Authentication of all such users are delegated to external systems. This<br>model represents a single auth source managed by VMware Cloud Foundation Operations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsauthsource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Immutable Identifier of the Auth Source</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>Name</maml:name> <maml:Description> <maml:para>Name of the External System. Set by admin when the source is added or imported into vROps. <br><i>name and id</i> of a source is unique with the exception that <b>name</b> can be modified by a system admin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSourcetype</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSourcetype</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Created</maml:name> <maml:Description> <maml:para>The Auth Source creation/import time 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>LastModified</maml:name> <maml:Description> <maml:para>The Auth Source last modification time in millisecond</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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Property</maml:name> <maml:Description> <maml:para>Properties of the Authentication Source.<br>The actual values of the metadata elements relevant for the specific Authentication Source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>Certificate details of the Authentication Source.<br>Typically this will be present if and only if the Authentication Source enforces SSL</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></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>Immutable Identifier of the Auth Source</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>Name</maml:name> <maml:Description> <maml:para>Name of the External System. Set by admin when the source is added or imported into vROps. <br><i>name and id</i> of a source is unique with the exception that <b>name</b> can be modified by a system admin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.AuthSourcetype</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.AuthSourcetype</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Created</maml:name> <maml:Description> <maml:para>The Auth Source creation/import time 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>LastModified</maml:name> <maml:Description> <maml:para>The Auth Source last modification time in millisecond</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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Property</maml:name> <maml:Description> <maml:para>Properties of the Authentication Source.<br>The actual values of the metadata elements relevant for the specific Authentication Source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>Certificate details of the Authentication Source.<br>Typically this will be present if and only if the Authentication Source enforces SSL</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Description "MyDescription" -Required $false -Modifiable $false $Properties = Initialize-VcfOpsProperties -Property $AuthSourceProperty $AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" -Description "MyDescription" -Links $Link -Properties $Properties $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $AuthSource = Initialize-VcfOpsAuthSource -Id "MyId" -Name "MyName" -SourceType $AuthSourcetype -Created 0 -LastModified 0 -Links $Link -Property $NameValue -Certificates $Certificate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsauthsource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate $AuthSource = Initialize-VcfOpsAuthSource -Name "MyName" -SourceType $AuthSourcetype -Property $NameValue -Certificates $Certificate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsauthsource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AuthSource</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsauthsourcetype</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-VcfOpsauthsourceproperty</command:name> <command:verb>Initialize</command:verb> <command:noun>authsourceproperty</command:noun> <maml:description> <maml:para>Meta data about auth source property</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Meta data about auth source property</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsauthsourceproperty</maml:name> <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 property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataType</maml:name> <maml:Description> <maml:para>The data type of the property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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 description of the property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Required</maml:name> <maml:Description> <maml:para>Flag that indicates whether property is required or not for creating/updating an auth source</maml:para> </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>Modifiable</maml:name> <maml:Description> <maml:para>Flag that indicates whether the property can be modified during an update operation 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DataType</maml:name> <maml:Description> <maml:para>The data type of the property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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 description of the property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Required</maml:name> <maml:Description> <maml:para>Flag that indicates whether property is required or not for creating/updating an auth source</maml:para> </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>Modifiable</maml:name> <maml:Description> <maml:para>Flag that indicates whether the property can be modified during an update operation 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>$AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Description "MyDescription" -Required $false -Modifiable $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsauthsourceproperty with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Required $false -Modifiable $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsauthsourceproperty with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AuthSourceProperty</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsauthsourcetype</command:name> <command:verb>Initialize</command:verb> <command:noun>authsourcetype</command:noun> <maml:description> <maml:para>This object represents the type of external authentication source supported by VMware Cloud Foundation Operations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This object represents the type of external authentication source supported by VMware Cloud Foundation Operations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsauthsourcetype</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of the source 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>Name</maml:name> <maml:Description> <maml:para>The name of the source 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>Description</maml:name> <maml:Description> <maml:para>Description about the authentication source 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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Properties</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Properties</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 identifier of the source 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>Name</maml:name> <maml:Description> <maml:para>The name of the source 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>Description</maml:name> <maml:Description> <maml:para>Description about the authentication source 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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Properties</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Properties</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Description "MyDescription" -Required $false -Modifiable $false $Properties = Initialize-VcfOpsProperties -Property $AuthSourceProperty $AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" -Description "MyDescription" -Links $Link -Properties $Properties </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsauthsourcetype with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $AuthSourcetype = Initialize-VcfOpsAuthSourcetype -Id "MyId" -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsauthsourcetype with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/AuthSourcetype</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsproperties</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-VcfOpsbadge</command:name> <command:verb>Initialize</command:verb> <command:noun>badge</command:noun> <maml:description> <maml:para>Badge in the System</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Badge in the System</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsbadge</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Available badges in the system</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Color</maml:name> <maml:Description> <maml:para>Enumeration that identifies the health of a Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Score</maml:name> <maml:Description> <maml:para>Score (value) associated with the Badge.<br>This number represents the absolute value of the Badge.<br>Typically the value is between 0-100 but this is not the<br>case all the time.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>Available badges in the system</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Color</maml:name> <maml:Description> <maml:para>Enumeration that identifies the health of a Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Score</maml:name> <maml:Description> <maml:para>Score (value) associated with the Badge.<br>This number represents the absolute value of the Badge.<br>Typically the value is between 0-100 but this is not the<br>case all the time.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Badge = Initialize-VcfOpsBadge -Type "ANOMALY" -Color "GREEN" -Score 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbadge with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Badge = Initialize-VcfOpsBadge -Type "ANOMALY" -Color "GREEN" -Score 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbadge with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Badge</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsbasesymptomset</command:name> <command:verb>Initialize</command:verb> <command:noun>basesymptomset</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-VcfOpsbasesymptomset</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {SYMPTOM_SET_COMPOSITE, SYMPTOM_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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {SYMPTOM_SET_COMPOSITE, SYMPTOM_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>$BaseSymptomSet = Initialize-VcfOpsBaseSymptomSet -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbasesymptomset with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BaseSymptomSet = Initialize-VcfOpsBaseSymptomSet </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbasesymptomset with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/BaseSymptomSet</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsbasicchargessettings</command:name> <command:verb>Initialize</command:verb> <command:noun>basicchargessettings</command:noun> <maml:description> <maml:para>Base class for cost-basic-charges-settings and rate-basic-charges-settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Base class for cost-basic-charges-settings and rate-basic-charges-settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsbasicchargessettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$BasicChargesSettings = Initialize-VcfOpsBasicChargesSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbasicchargessettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BasicChargesSettings = Initialize-VcfOpsBasicChargesSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbasicchargessettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/BasicChargesSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsbasicrate</command:name> <command:verb>Initialize</command:verb> <command:noun>basicrate</command:noun> <maml:description> <maml:para>Base class for basic rate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Base class for basic rate.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsbasicrate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$BasicRate = Initialize-VcfOpsBasicRate -ChargePeriod "HOURLY" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbasicrate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BasicRate = Initialize-VcfOpsBasicRate -ChargePeriod "HOURLY" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbasicrate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/BasicRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsbillgenerationrequest</command:name> <command:verb>Initialize</command:verb> <command:noun>billgenerationrequest</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-VcfOpsbillgenerationrequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>The title of the bill</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the bill</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BillingStartTime</maml:name> <maml:Description> <maml:para>Billing start time 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BillingEndTime</maml:name> <maml:Description> <maml:para>Billing end time 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>The resource ids for which the bill needs to be generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>PolicyId</maml:name> <maml:Description> <maml:para>The UUID of the policy which is used for RegionQuota bill generation</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>TimeZone</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.BillGenerationRequestTimeZone</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.BillGenerationRequestTimeZone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Title</maml:name> <maml:Description> <maml:para>The title of the bill</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the bill</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BillingStartTime</maml:name> <maml:Description> <maml:para>Billing start time 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BillingEndTime</maml:name> <maml:Description> <maml:para>Billing end time 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>The resource ids for which the bill needs to be generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>PolicyId</maml:name> <maml:Description> <maml:para>The UUID of the policy which is used for RegionQuota bill generation</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>TimeZone</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.BillGenerationRequestTimeZone</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.BillGenerationRequestTimeZone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $BillGenerationRequestTimeZone = Initialize-VcfOpsBillGenerationRequestTimeZone -DisplayName "MyDisplayName" -Id "MyId" -Dstsavings 0 -RawOffset 0 $BillGenerationRequest = Initialize-VcfOpsBillGenerationRequest -Title "MyTitle" -Description "MyDescription" -BillingStartTime 0 -BillingEndTime 0 -ResourceIds "MyResourceIds" -PolicyId "MyPolicyId" -TimeZone $BillGenerationRequestTimeZone </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbillgenerationrequest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BillGenerationRequestTimeZone = Initialize-VcfOpsBillGenerationRequestTimeZone $BillGenerationRequest = Initialize-VcfOpsBillGenerationRequest -Title "MyTitle" -BillingStartTime 0 -BillingEndTime 0 -ResourceIds "MyResourceIds" -TimeZone $BillGenerationRequestTimeZone </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbillgenerationrequest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/BillGenerationRequest</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsbillgenerationrequesttimeZone</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-VcfOpsbillgenerationrequesttimeZone</command:name> <command:verb>Initialize</command:verb> <command:noun>billgenerationrequesttimeZone</command:noun> <maml:description> <maml:para>Billing timeZone</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Billing timeZone</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsbillgenerationrequesttimeZone</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</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>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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Dstsavings</maml:name> <maml:Description> <maml:para>No description available.</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>RawOffset</maml:name> <maml:Description> <maml:para>No description available.</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>DisplayName</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>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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Dstsavings</maml:name> <maml:Description> <maml:para>No description available.</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>RawOffset</maml:name> <maml:Description> <maml:para>No description available.</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>$BillGenerationRequestTimeZone = Initialize-VcfOpsBillGenerationRequestTimeZone -DisplayName "MyDisplayName" -Id "MyId" -Dstsavings 0 -RawOffset 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbillgenerationrequesttimeZone with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$BillGenerationRequestTimeZone = Initialize-VcfOpsBillGenerationRequestTimeZone </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbillgenerationrequesttimeZone with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/BillGenerationRequestTimeZone</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsbillsummaryrequest</command:name> <command:verb>Initialize</command:verb> <command:noun>billsummaryrequest</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-VcfOpsbillsummaryrequest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Period</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.DateRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.DateRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SearchCriterias</maml:name> <maml:Description> <maml:para>The list of searchCriterias for getting bill summaries</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.SearchCriteria></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.SearchCriteria></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>Period</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.DateRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.DateRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SearchCriterias</maml:name> <maml:Description> <maml:para>The list of searchCriterias for getting bill summaries</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.SearchCriteria></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.SearchCriteria></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DateRange = Initialize-VcfOpsDateRange -Start 0 -End 0 $SearchCriteria = Initialize-VcfOpsSearchCriteria -Key "RESOURCE_NAME" -Value "MyValue" $BillSummaryRequest = Initialize-VcfOpsBillSummaryRequest -Period $DateRange -SearchCriterias $SearchCriteria </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbillsummaryrequest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $BillSummaryRequest = Initialize-VcfOpsBillSummaryRequest </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsbillsummaryrequest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/BillSummaryRequest</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsdaterange</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-VcfOpscapacity</command:name> <command:verb>Initialize</command:verb> <command:noun>capacity</command:noun> <maml:description> <maml:para>Model representing capacity settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing capacity settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscapacity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CapacityAllocationSettings</maml:name> <maml:Description> <maml:para>Collection of capacity allocation model settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CapacityAllocationSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CapacityAllocationSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomProfileSettings</maml:name> <maml:Description> <maml:para>Collection of custom profile settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CustomProfileSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CustomProfileSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CapacityBufferSettings</maml:name> <maml:Description> <maml:para>Collection of capacity buffer settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CapacityBufferSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CapacityBufferSettings></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>CapacityAllocationSettings</maml:name> <maml:Description> <maml:para>Collection of capacity allocation model settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CapacityAllocationSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CapacityAllocationSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomProfileSettings</maml:name> <maml:Description> <maml:para>Collection of custom profile settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CustomProfileSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CustomProfileSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CapacityBufferSettings</maml:name> <maml:Description> <maml:para>Collection of capacity buffer settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CapacityBufferSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CapacityBufferSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CapacityAllocationSettings = Initialize-VcfOpsCapacityAllocationSettings $CustomProfileSettings = Initialize-VcfOpsCustomProfileSettings $CapacityBufferSettings = Initialize-VcfOpsCapacityBufferSettings $Capacity = Initialize-VcfOpsCapacity -CapacityAllocationSettings $CapacityAllocationSettings -CustomProfileSettings $CustomProfileSettings -CapacityBufferSettings $CapacityBufferSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Capacity = Initialize-VcfOpsCapacity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Capacity</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscapacityallocation</command:name> <command:verb>Initialize</command:verb> <command:noun>capacityallocation</command:noun> <maml:description> <maml:para>Model representing capacity allocation settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing capacity allocation settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscapacityallocation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Cpu</maml:name> <maml:Description> <maml:para>Ratio of cpu</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Memory</maml:name> <maml:Description> <maml:para>Ratio of memory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Diskspace</maml:name> <maml:Description> <maml:para>Ratio of diskspace</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PoweredOffVmsConsidered</maml:name> <maml:Description> <maml:para>Consider Powered off 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Cpu</maml:name> <maml:Description> <maml:para>Ratio of cpu</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Memory</maml:name> <maml:Description> <maml:para>Ratio of memory</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Diskspace</maml:name> <maml:Description> <maml:para>Ratio of diskspace</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PoweredOffVmsConsidered</maml:name> <maml:Description> <maml:para>Consider Powered off 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CapacityAllocation = Initialize-VcfOpsCapacityAllocation -Cpu 0 -Memory 0 -Diskspace 0 -PoweredOffVmsConsidered $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacityallocation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CapacityAllocation = Initialize-VcfOpsCapacityAllocation </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacityallocation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CapacityAllocation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscapacityallocationsettings</command:name> <command:verb>Initialize</command:verb> <command:noun>capacityallocationsettings</command:noun> <maml:description> <maml:para>Allocation Model differs to Demand Model as it does not consider Utilization. It is simply based on configured amount (e.g. 4 vCPU, 16 GB virtual RAM, 100 GB virtual Disk) that is allocated to VMs. As a result, Demand Model is still considered when Allocation is enabled.<br>Note: These settings will also apply to What-If Analysis, Committed Projects, and WLP calculations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Allocation Model differs to Demand Model as it does not consider Utilization. It is simply based on configured amount (e.g. 4 vCPU, 16 GB virtual RAM, 100 GB virtual Disk) that is allocated to VMs. As a result, Demand Model is still considered when Allocation is enabled.<br>Note: These settings will also apply to What-If Analysis, Committed Projects, and WLP calculations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscapacityallocationsettings</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>$CapacityAllocationSettings = Initialize-VcfOpsCapacityAllocationSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacityallocationsettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CapacityAllocationSettings = Initialize-VcfOpsCapacityAllocationSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacityallocationsettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CapacityAllocationSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscapacitybuffer</command:name> <command:verb>Initialize</command:verb> <command:noun>capacitybuffer</command:noun> <maml:description> <maml:para>Capacity buffer settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Capacity buffer settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscapacitybuffer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Cpu</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Memory</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Diskspace</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</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>Cpu</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Memory</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Diskspace</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacityBufferConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CapacityBufferConfig = Initialize-VcfOpsCapacityBufferConfig -Demand 0 -Usage 0 -Allocation 0 $CapacityBuffer = Initialize-VcfOpsCapacityBuffer -Cpu $CapacityBufferConfig -Memory $CapacityBufferConfig -Diskspace $CapacityBufferConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitybuffer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CapacityBuffer = Initialize-VcfOpsCapacityBuffer </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitybuffer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CapacityBuffer</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscapacitybufferconfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscapacitybufferconfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscapacitybufferconfig</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-VcfOpscapacitybufferconfig</command:name> <command:verb>Initialize</command:verb> <command:noun>capacitybufferconfig</command:noun> <maml:description> <maml:para>Capacity buffer configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Capacity buffer configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscapacitybufferconfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Demand</maml:name> <maml:Description> <maml:para>Demand value. This field applicable only for Cluster Compute Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Usage</maml:name> <maml:Description> <maml:para>Usage Value. This field applicable only for Datastore and Datastore Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Allocation</maml:name> <maml:Description> <maml:para>Allocation value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</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>Demand</maml:name> <maml:Description> <maml:para>Demand value. This field applicable only for Cluster Compute Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Usage</maml:name> <maml:Description> <maml:para>Usage Value. This field applicable only for Datastore and Datastore Cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Allocation</maml:name> <maml:Description> <maml:para>Allocation value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CapacityBufferConfig = Initialize-VcfOpsCapacityBufferConfig -Demand 0 -Usage 0 -Allocation 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitybufferconfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CapacityBufferConfig = Initialize-VcfOpsCapacityBufferConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitybufferconfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CapacityBufferConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscapacitybuffersettings</command:name> <command:verb>Initialize</command:verb> <command:noun>capacitybuffersettings</command:noun> <maml:description> <maml:para>Capacity buffer reduces the usable capacity. In vSphere Cluster, it is applied after High Availability (HA). Use buffer as safety net in capacity.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Capacity buffer reduces the usable capacity. In vSphere Cluster, it is applied after High Availability (HA). Use buffer as safety net in capacity.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscapacitybuffersettings</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>$CapacityBufferSettings = Initialize-VcfOpsCapacityBufferSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitybuffersettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CapacityBufferSettings = Initialize-VcfOpsCapacityBufferSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitybuffersettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CapacityBufferSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscapacityconsumer</command:name> <command:verb>Initialize</command:verb> <command:noun>capacityconsumer</command:noun> <maml:description> <maml:para>Consumer of custom profile</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Consumer of custom profile</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscapacityconsumer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>Adapter kind of the consumer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>Resource kind of the consumer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>AdapterKind</maml:name> <maml:Description> <maml:para>Adapter kind of the consumer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>Resource kind of the consumer</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CapacityConsumer = Initialize-VcfOpsCapacityConsumer -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacityconsumer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CapacityConsumer = Initialize-VcfOpsCapacityConsumer -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacityconsumer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CapacityConsumer</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscapacitycustomprofile</command:name> <command:verb>Initialize</command:verb> <command:noun>capacitycustomprofile</command:noun> <maml:description> <maml:para>Custom profile UUID settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Custom profile UUID settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscapacitycustomprofile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomProfileIds</maml:name> <maml:Description> <maml:para>Collection of custom profile uuids.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>CustomProfileIds</maml:name> <maml:Description> <maml:para>Collection of custom profile uuids.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CapacityCustomProfile = Initialize-VcfOpsCapacityCustomProfile -CustomProfileIds "MyCustomProfileIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitycustomprofile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CapacityCustomProfile = Initialize-VcfOpsCapacityCustomProfile -CustomProfileIds "MyCustomProfileIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitycustomprofile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CapacityCustomProfile</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscapacitysettings</command:name> <command:verb>Initialize</command:verb> <command:noun>capacitysettings</command:noun> <maml:description> <maml:para>Model representing capacity section.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing capacity section.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscapacitysettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Capacity</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Capacity</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Capacity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CriticalityThresholds</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CriticalityThresholds</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CriticalityThresholds</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>Capacity</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Capacity</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Capacity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CriticalityThresholds</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CriticalityThresholds</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CriticalityThresholds</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CapacityAllocationSettings = Initialize-VcfOpsCapacityAllocationSettings $CustomProfileSettings = Initialize-VcfOpsCustomProfileSettings $CapacityBufferSettings = Initialize-VcfOpsCapacityBufferSettings $Capacity = Initialize-VcfOpsCapacity -CapacityAllocationSettings $CapacityAllocationSettings -CustomProfileSettings $CustomProfileSettings -CapacityBufferSettings $CapacityBufferSettings $CriticalityThresholdsSettings = Initialize-VcfOpsCriticalityThresholdsSettings $CriticalityThresholds = Initialize-VcfOpsCriticalityThresholds -TimeRemainingSettings $CriticalityThresholdsSettings -CapacityRemainingSettings $CriticalityThresholdsSettings -WorkloadSettings $CriticalityThresholdsSettings $CapacitySettings = Initialize-VcfOpsCapacitySettings -Capacity $Capacity -CriticalityThresholds $CriticalityThresholds </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitysettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CapacitySettings = Initialize-VcfOpsCapacitySettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscapacitysettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CapacitySettings</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscapacity</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscriticalitythresholds</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-VcfOpscertificate</command:name> <command:verb>Initialize</command:verb> <command:noun>certificate</command:noun> <maml:description> <maml:para>Untrusted certificate representation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Untrusted certificate representation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscertificate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Thumbprint</maml:name> <maml:Description> <maml:para>If the source returns an untrusted certificate,this field is used to represent the certificate guid</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateDetails</maml:name> <maml:Description> <maml:para>If the source returns an untrusted certificate, this field is used to represent certificate details. It also contains <i>Algorithm</i>, <i>Signature (base64-encoded)</i> and <i>SignedCertificate (base64-encoded)</i> values.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Certificate</maml:name> <maml:Description> <maml:para>If the source returns an untrusted certificate, this field is used to represent the full certificate. Currently used only for VIDB and provided 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>IssuedTo</maml:name> <maml:Description> <maml:para>The issuedTo date 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IssuedBy</maml:name> <maml:Description> <maml:para>The issuedBy parameter 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Expires</maml:name> <maml:Description> <maml:para>Expiration date 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Thumbprint</maml:name> <maml:Description> <maml:para>If the source returns an untrusted certificate,this field is used to represent the certificate guid</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CertificateDetails</maml:name> <maml:Description> <maml:para>If the source returns an untrusted certificate, this field is used to represent certificate details. It also contains <i>Algorithm</i>, <i>Signature (base64-encoded)</i> and <i>SignedCertificate (base64-encoded)</i> values.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_Certificate</maml:name> <maml:Description> <maml:para>If the source returns an untrusted certificate, this field is used to represent the full certificate. Currently used only for VIDB and provided 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>IssuedTo</maml:name> <maml:Description> <maml:para>The issuedTo date 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IssuedBy</maml:name> <maml:Description> <maml:para>The issuedBy parameter 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Expires</maml:name> <maml:Description> <maml:para>Expiration date 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>$Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscertificate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Certificate = Initialize-VcfOpsCertificate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscertificate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Certificate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpschangedatastoresettings</command:name> <command:verb>Initialize</command:verb> <command:noun>changedatastoresettings</command:noun> <maml:description> <maml:para>Model representing change datastore settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing change datastore settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpschangedatastoresettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$ChangeDatastoreSettings = Initialize-VcfOpsChangeDatastoreSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpschangedatastoresettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ChangeDatastoreSettings = Initialize-VcfOpsChangeDatastoreSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpschangedatastoresettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ChangeDatastoreSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpschargetypeadditionalrate</command:name> <command:verb>Initialize</command:verb> <command:noun>chargetypeadditionalrate</command:noun> <maml:description> <maml:para>Model representing charge type with additional configurations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing charge type with additional configurations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpschargetypeadditionalrate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ChargeTypeAdditionalRate = Initialize-VcfOpsChargeTypeAdditionalRate -ChargePeriod "HOURLY" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpschargetypeadditionalrate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ChargeTypeAdditionalRate = Initialize-VcfOpsChargeTypeAdditionalRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpschargetypeadditionalrate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ChargeTypeAdditionalRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpschargetypepowerstaterate</command:name> <command:verb>Initialize</command:verb> <command:noun>chargetypepowerstaterate</command:noun> <maml:description> <maml:para>Basic rate with charged type and powered state on settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Basic rate with charged type and powered state on settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpschargetypepowerstaterate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ChargeTypePowerStateRate = Initialize-VcfOpsChargeTypePowerStateRate -ChargePeriod "HOURLY" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpschargetypepowerstaterate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ChargeTypePowerStateRate = Initialize-VcfOpsChargeTypePowerStateRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpschargetypepowerstaterate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ChargeTypePowerStateRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpschargebackreportschedule</command:name> <command:verb>Initialize</command:verb> <command:noun>chargebackreportschedule</command:noun> <maml:description> <maml:para>Model to represent a Chargeback Report Schedule</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model to represent a Chargeback Report Schedule</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpschargebackreportschedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>UUID of the schedule</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>ResourceIds</maml:name> <maml:Description> <maml:para>Resource identifiers for which the schedule will be created. Currently we support Schedules for a single Resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StartDate</maml:name> <maml:Description> <maml:para>Starting time when the Report Schedule comes into effect. Defaults to the current 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>WeekOfMonth</maml:name> <maml:Description> <maml:para>Week of the Month</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReportScheduleType</maml:name> <maml:Description> <maml:para>Types of schedule</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DaysOfTheWeek</maml:name> <maml:Description> <maml:para>The days of the week this Schedule repeats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ChargebackReportSchedule.DaysOfTheWeekEnum></command:parameterValue> <dev:type> <maml:name>List<ChargebackReportSchedule.DaysOfTheWeekEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartHour</maml:name> <maml:Description> <maml:para>The hour of the day when the Schedule runs. Defaults to 8.</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>StartMinute</maml:name> <maml:Description> <maml:para>The minutes of the hour when the Schedule runs. Defaults to 0.</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>Recurrence</maml:name> <maml:Description> <maml:para>Indicates the recurrence period of the Schedule. Defaults to 1.</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>DayOfTheMonth</maml:name> <maml:Description> <maml:para>The days of the month when the Schedule will run - Valid values are from 1-31</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>UUID of the schedule</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>ResourceIds</maml:name> <maml:Description> <maml:para>Resource identifiers for which the schedule will be created. Currently we support Schedules for a single Resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StartDate</maml:name> <maml:Description> <maml:para>Starting time when the Report Schedule comes into effect. Defaults to the current 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>WeekOfMonth</maml:name> <maml:Description> <maml:para>Week of the Month</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReportScheduleType</maml:name> <maml:Description> <maml:para>Types of schedule</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DaysOfTheWeek</maml:name> <maml:Description> <maml:para>The days of the week this Schedule repeats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ChargebackReportSchedule.DaysOfTheWeekEnum></command:parameterValue> <dev:type> <maml:name>List<ChargebackReportSchedule.DaysOfTheWeekEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartHour</maml:name> <maml:Description> <maml:para>The hour of the day when the Schedule runs. Defaults to 8.</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>StartMinute</maml:name> <maml:Description> <maml:para>The minutes of the hour when the Schedule runs. Defaults to 0.</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>Recurrence</maml:name> <maml:Description> <maml:para>Indicates the recurrence period of the Schedule. Defaults to 1.</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>DayOfTheMonth</maml:name> <maml:Description> <maml:para>The days of the month when the Schedule will run - Valid values are from 1-31</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>"UNKNOWN"$ChargebackReportSchedule = Initialize-VcfOpsChargebackReportSchedule -Id "MyId" -ResourceIds "MyResourceIds" -StartDate "MyStartDate" -WeekOfMonth "UNKNOWNN" -ReportScheduleType "UNKNOWN" -DaysOfTheWeek "UNKNOWN" -StartHour 0 -StartMinute 0 -Recurrence 0 -DayOfTheMonth 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpschargebackreportschedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ChargebackReportSchedule = Initialize-VcfOpsChargebackReportSchedule -ResourceIds "MyResourceIds" -StartDate "MyStartDate" -ReportScheduleType "UNKNOWN" -Recurrence 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpschargebackreportschedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ChargebackReportSchedule</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsCloudAccountIntegration</command:name> <command:verb>Initialize</command:verb> <command:noun>CloudAccountIntegration</command:noun> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating or updating cloud account integration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating or updating cloud account integration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsCloudAccountIntegration</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 existing cloud account integration, must be null at creation</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>Name</maml:name> <maml:Description> <maml:para>The name of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Optional description of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The Collector instance used by this cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>The Collector Group ID to be used for this cloud account integration</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>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>Cloud account integration specific resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>List of new trusted certificates, must be provided upon creation/update of new cloud account integration, for establishing connection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialInstanceId</maml:name> <maml:Description> <maml:para>Credential Instance identifier, for this cloud account integration.</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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of existing cloud account integration, must be null at creation</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>Name</maml:name> <maml:Description> <maml:para>The name of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Optional description of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The Collector instance used by this cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>The Collector Group ID to be used for this cloud account integration</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>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>Cloud account integration specific resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>List of new trusted certificates, must be provided upon creation/update of new cloud account integration, for establishing connection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialInstanceId</maml:name> <maml:Description> <maml:para>Credential Instance identifier, for this cloud account integration.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $CloudAccountIntegration = Initialize-VcfOpsCloudAccountIntegration -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -ResourceIdentifiers $NameValue -Certificates $Certificate -CredentialInstanceId "MyCredentialInstanceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsCloudAccountIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $CloudAccountIntegration = Initialize-VcfOpsCloudAccountIntegration -Name "MyName" -ResourceIdentifiers $NameValue </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsCloudAccountIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CloudAccountIntegration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsclusterheadroomsettings</command:name> <command:verb>Initialize</command:verb> <command:noun>clusterheadroomsettings</command:noun> <maml:description> <maml:para>Headroom provides a buffer of space for the cluster, which may cause a rebalance to occur earlier than it would otherwise.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Headroom provides a buffer of space for the cluster, which may cause a rebalance to occur earlier than it would otherwise.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsclusterheadroomsettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$ClusterHeadroomSettings = Initialize-VcfOpsClusterHeadroomSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsclusterheadroomsettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ClusterHeadroomSettings = Initialize-VcfOpsClusterHeadroomSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsclusterheadroomsettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ClusterHeadroomSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscollectorgroup</command:name> <command:verb>Initialize</command:verb> <command:noun>collectorgroup</command:noun> <maml:description> <maml:para>Represents a Collector group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a Collector group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscollectorgroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of the Collector Group. <br>This is system generated during the creation time.</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>Name</maml:name> <maml:Description> <maml:para>Name of the Collector Group. This uniquely identifier a Collector Group in the system but is user specified and mutable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Collector Group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>Set of Collector IDs that belong to a Collector Group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>SystemDefined</maml:name> <maml:Description> <maml:para>Is the Collector group system defined? This is a Read Only attribute and is set by the system.</maml:para> </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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HaEnabled</maml:name> <maml:Description> <maml:para>is the collector group ha enabled 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>LbEnabled</maml:name> <maml:Description> <maml:para>is the collector group LB enabled 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>VirtualIP</maml:name> <maml:Description> <maml:para>virtual IP value of collector group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Identifier of the Collector Group. <br>This is system generated during the creation time.</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>Name</maml:name> <maml:Description> <maml:para>Name of the Collector Group. This uniquely identifier a Collector Group in the system but is user specified and mutable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Collector Group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>Set of Collector IDs that belong to a Collector Group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>SystemDefined</maml:name> <maml:Description> <maml:para>Is the Collector group system defined? This is a Read Only attribute and is set by the system.</maml:para> </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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HaEnabled</maml:name> <maml:Description> <maml:para>is the collector group ha enabled 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>LbEnabled</maml:name> <maml:Description> <maml:para>is the collector group LB enabled 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>VirtualIP</maml:name> <maml:Description> <maml:para>virtual IP value of collector group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $CollectorGroup = Initialize-VcfOpsCollectorGroup -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId 0 -SystemDefined $false -Links $Link -HaEnabled $false -LbEnabled $false -VirtualIP "MyVirtualIP" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscollectorgroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CollectorGroup = Initialize-VcfOpsCollectorGroup -Id "MyId" -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscollectorgroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CollectorGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscompositesymptomset</command:name> <command:verb>Initialize</command:verb> <command:noun>compositesymptomset</command:noun> <maml:description> <maml:para>An AND/OR composition of BaseSymptomSet objects</maml:para> </maml:description> </command:details> <maml:description> <maml:para>An AND/OR composition of BaseSymptomSet objects</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscompositesymptomset</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {SYMPTOM_SET_COMPOSITE, SYMPTOM_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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {SYMPTOM_SET_COMPOSITE, SYMPTOM_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>$CompositeSymptomSet = Initialize-VcfOpsCompositeSymptomSet -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscompositesymptomset with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CompositeSymptomSet = Initialize-VcfOpsCompositeSymptomSet </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscompositesymptomset with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CompositeSymptomSet</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscondition</command:name> <command:verb>Initialize</command:verb> <command:noun>condition</command:noun> <maml:description> <maml:para>Base class for Symptom Definition conditions.<br>For JSON the class descendants will generate with a field named \"type\" with one of the following values:<br><i> \"CONDITION_HT\", \"CONDITION_HT_SUPER\", \"CONDITION_DT\", \"CONDITION_DT_SUPER\", \"CONDITION_PROPERTY_STRING\", \"CONDITION_PROPERTY_NUMERIC\", \"CONDITION_FAULT\", \"CONDITION_METRIC_EVENT\", \"CONDITION_MESSAGE_EVENT\" </i></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Base class for Symptom Definition conditions.<br>For JSON the class descendants will generate with a field named \"type\" with one of the following values:<br><i> \"CONDITION_HT\", \"CONDITION_HT_SUPER\", \"CONDITION_DT\", \"CONDITION_DT_SUPER\", \"CONDITION_PROPERTY_STRING\", \"CONDITION_PROPERTY_NUMERIC\", \"CONDITION_FAULT\", \"CONDITION_METRIC_EVENT\", \"CONDITION_MESSAGE_EVENT\" </i></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Condition = Initialize-VcfOpsCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Condition = Initialize-VcfOpsCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Condition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscontentexport</command:name> <command:verb>Initialize</command:verb> <command:noun>contentexport</command:noun> <maml:description> <maml:para>Export Operation Details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export Operation Details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscontentexport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Scope of content export operation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContentTypes</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ContentExport.ContentTypesEnum></command:parameterValue> <dev:type> <maml:name>List<ContentExport.ContentTypesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Scope of content export operation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContentTypes</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ContentExport.ContentTypesEnum></command:parameterValue> <dev:type> <maml:name>List<ContentExport.ContentTypesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"VIEW_DEFINITIONS" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ContentExport = Initialize-VcfOpsContentExport -Scope "ALL" -ContentTypes "VIEW_DEFINITIONS" -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscontentexport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>"VIEW_DEFINITIONS" $ContentExport = Initialize-VcfOpsContentExport -Scope "ALL" -ContentTypes "VIEW_DEFINITIONS" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscontentexport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ContentExport</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscostbasicchargessettings</command:name> <command:verb>Initialize</command:verb> <command:noun>costbasicchargessettings</command:noun> <maml:description> <maml:para>Model representing VC basic charges settings based on cost</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing VC basic charges settings based on cost</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscostbasicchargessettings</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>$CostBasicChargesSettings = Initialize-VcfOpsCostBasicChargesSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscostbasicchargessettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CostBasicChargesSettings = Initialize-VcfOpsCostBasicChargesSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscostbasicchargessettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CostBasicChargesSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscreateadapterinstance</command:name> <command:verb>Initialize</command:verb> <command:noun>createadapterinstance</command:noun> <maml:description> <maml:para>A DTO that serves as the structure of the payload data for creating a new adapter instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A DTO that serves as the structure of the payload data for creating a new adapter instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscreateadapterinstance</maml:name> <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 Adapter 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Optional description of the Adapter 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The Collector instance used by this adapter instance. If not specified, the system will choose an appropriate Collector for you</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>The Collector Group ID to be used for this Adapter Instance. If not specified, the system will choose an appropriate Collector group for you</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>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>Adapter instance specific resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Credential</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Credential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MonitoringInterval</maml:name> <maml:Description> <maml:para>Minutes part of the monitoring Interval of the Adapter Instance, where the monitoring Interval is the frequency of data source query for stats and properties.</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>MonitoringIntervalSeconds</maml:name> <maml:Description> <maml:para>Seconds part of the monitoring Interval of the Adapter Instance, where the monitoring Interval is the frequency of data source query for stats and properties.</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>PhysicalDatacenterId</maml:name> <maml:Description> <maml:para>The Physical Datacenter ID to be used for this Adapter Instance. It is Optional</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>Name</maml:name> <maml:Description> <maml:para>The name of the Adapter 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Optional description of the Adapter 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The Collector instance used by this adapter instance. If not specified, the system will choose an appropriate Collector for you</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>The Collector Group ID to be used for this Adapter Instance. If not specified, the system will choose an appropriate Collector group for you</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>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind 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>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>Adapter instance specific resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Credential</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Credential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MonitoringInterval</maml:name> <maml:Description> <maml:para>Minutes part of the monitoring Interval of the Adapter Instance, where the monitoring Interval is the frequency of data source query for stats and properties.</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>MonitoringIntervalSeconds</maml:name> <maml:Description> <maml:para>Seconds part of the monitoring Interval of the Adapter Instance, where the monitoring Interval is the frequency of data source query for stats and properties.</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>PhysicalDatacenterId</maml:name> <maml:Description> <maml:para>The Physical Datacenter ID to be used for this Adapter Instance. It is Optional</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Credential = Initialize-VcfOpsCredential -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" -Fields $NameValue -Editable $false $CreateAdapterInstance = Initialize-VcfOpsCreateAdapterInstance -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -AdapterKindKey "MyAdapterKindKey" -ResourceIdentifiers $NameValue -Credential $Credential -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -PhysicalDatacenterId "MyPhysicalDatacenterId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscreateadapterinstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CreateAdapterInstance = Initialize-VcfOpsCreateAdapterInstance -Name "MyName" -AdapterKindKey "MyAdapterKindKey" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscreateadapterinstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CreateAdapterInstance</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscredential</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-VcfOpscredential</command:name> <command:verb>Initialize</command:verb> <command:noun>credential</command:noun> <maml:description> <maml:para>The Credential Instance information</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Credential Instance information</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Credential Instance identifier.<br>This should be null for credential instance creation requests and must have a value for all other requests.</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>Name</maml:name> <maml:Description> <maml:para>The name 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind key 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialKindKey</maml:name> <maml:Description> <maml:para>The credential kind 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fields</maml:name> <maml:Description> <maml:para>Collection of name,value pairs that capture the credential specific data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Editable</maml:name> <maml:Description> <maml:para>Is credential editable 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>Id</maml:name> <maml:Description> <maml:para>Credential Instance identifier.<br>This should be null for credential instance creation requests and must have a value for all other requests.</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>Name</maml:name> <maml:Description> <maml:para>The name 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The Adapter Kind key 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialKindKey</maml:name> <maml:Description> <maml:para>The credential kind 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Fields</maml:name> <maml:Description> <maml:para>Collection of name,value pairs that capture the credential specific data</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Editable</maml:name> <maml:Description> <maml:para>Is credential editable 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> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Credential = Initialize-VcfOpsCredential -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" -Fields $NameValue -Editable $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Credential = Initialize-VcfOpsCredential -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -CredentialKindKey "MyCredentialKindKey" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Credential</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscredentialparams</command:name> <command:verb>Initialize</command:verb> <command:noun>credentialparams</command:noun> <maml:description> <maml:para>A model that serves as the structure of credential params</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A model that serves as the structure of credential params</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscredentialparams</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>The username 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>The password 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>Username</maml:name> <maml:Description> <maml:para>The username 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>The password 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CredentialParams = Initialize-VcfOpsCredentialParams -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscredentialparams with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CredentialParams = Initialize-VcfOpsCredentialParams -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscredentialparams with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CredentialParams</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscriticalitythresholds</command:name> <command:verb>Initialize</command:verb> <command:noun>criticalitythresholds</command:noun> <maml:description> <maml:para>Model representing Criticality Thresholds.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing Criticality Thresholds.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscriticalitythresholds</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TimeRemainingSettings</maml:name> <maml:Description> <maml:para>Time Remaining is how many days you have until the utilization projection crosses the usable capacity threshold. It has 2 settings: Conservative and Aggressive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CapacityRemainingSettings</maml:name> <maml:Description> <maml:para>Capacity Remaining is the not consumed percentage of usable capacity.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WorkloadSettings</maml:name> <maml:Description> <maml:para>Workload is the immediate % of capacity consumed of the most constrained of several key resource containers. Since workload changes every collection cycle, you can set how many cycles it takes to trigger or clear an alert.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></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>TimeRemainingSettings</maml:name> <maml:Description> <maml:para>Time Remaining is how many days you have until the utilization projection crosses the usable capacity threshold. It has 2 settings: Conservative and Aggressive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CapacityRemainingSettings</maml:name> <maml:Description> <maml:para>Capacity Remaining is the not consumed percentage of usable capacity.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WorkloadSettings</maml:name> <maml:Description> <maml:para>Workload is the immediate % of capacity consumed of the most constrained of several key resource containers. Since workload changes every collection cycle, you can set how many cycles it takes to trigger or clear an alert.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CriticalityThresholdsSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CriticalityThresholdsSettings = Initialize-VcfOpsCriticalityThresholdsSettings $CriticalityThresholds = Initialize-VcfOpsCriticalityThresholds -TimeRemainingSettings $CriticalityThresholdsSettings -CapacityRemainingSettings $CriticalityThresholdsSettings -WorkloadSettings $CriticalityThresholdsSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscriticalitythresholds with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CriticalityThresholds = Initialize-VcfOpsCriticalityThresholds </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscriticalitythresholds with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CriticalityThresholds</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscriticalitythresholdsconfig</command:name> <command:verb>Initialize</command:verb> <command:noun>criticalitythresholdsconfig</command:noun> <maml:description> <maml:para>Model representing Criticality Thresholds Configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing Criticality Thresholds Configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscriticalitythresholdsconfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Critical</maml:name> <maml:Description> <maml:para>Threshold for critical. It is null, when criticality level is disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para>Threshold for immediate. It is null, when criticality level is disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Warning</maml:name> <maml:Description> <maml:para>Threshold for warning. It is null, when criticality level is disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</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>Critical</maml:name> <maml:Description> <maml:para>Threshold for critical. It is null, when criticality level is disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para>Threshold for immediate. It is null, when criticality level is disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Warning</maml:name> <maml:Description> <maml:para>Threshold for warning. It is null, when criticality level is disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CriticalityThresholdsConfig = Initialize-VcfOpsCriticalityThresholdsConfig -Critical 0 -Immediate 0 -Warning 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscriticalitythresholdsconfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CriticalityThresholdsConfig = Initialize-VcfOpsCriticalityThresholdsConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscriticalitythresholdsconfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CriticalityThresholdsConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscriticalitythresholdssettings</command:name> <command:verb>Initialize</command:verb> <command:noun>criticalitythresholdssettings</command:noun> <maml:description> <maml:para>Model representing Criticality Thresholds Settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing Criticality Thresholds Settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscriticalitythresholdssettings</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>$CriticalityThresholdsSettings = Initialize-VcfOpsCriticalityThresholdsSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscriticalitythresholdssettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CriticalityThresholdsSettings = Initialize-VcfOpsCriticalityThresholdsSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscriticalitythresholdssettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CriticalityThresholdsSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscurrencyconfig</command:name> <command:verb>Initialize</command:verb> <command:noun>currencyconfig</command:noun> <maml:description> <maml:para>Currency configuration details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Currency configuration details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscurrencyconfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Code</maml:name> <maml:Description> <maml:para>ISO 4217 currency code for this currency</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Code</maml:name> <maml:Description> <maml:para>ISO 4217 currency code for this currency</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CurrencyConfig = Initialize-VcfOpsCurrencyConfig -Code "MyCode" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscurrencyconfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CurrencyConfig = Initialize-VcfOpsCurrencyConfig -Code "MyCode" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscurrencyconfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CurrencyConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscustomdatacenter</command:name> <command:verb>Initialize</command:verb> <command:noun>customdatacenter</command:noun> <maml:description> <maml:para>Custom datacenter</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Custom datacenter</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscustomdatacenter</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of custom datacenter</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>Name</maml:name> <maml:Description> <maml:para>Name of custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChildResourceIds</maml:name> <maml:Description> <maml:para>Resource IDs included in custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<Guid></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>Identifier of custom datacenter</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>Name</maml:name> <maml:Description> <maml:para>Name of custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChildResourceIds</maml:name> <maml:Description> <maml:para>Resource IDs included in custom datacenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CustomDatacenter = Initialize-VcfOpsCustomDatacenter -Id "MyId" -Name "MyName" -Description "MyDescription" -ChildResourceIds "MyChildResourceIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomdatacenter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CustomDatacenter = Initialize-VcfOpsCustomDatacenter -Name "MyName" -ChildResourceIds "MyChildResourceIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomdatacenter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CustomDatacenter</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscustomgroup</command:name> <command:verb>Initialize</command:verb> <command:noun>customgroup</command:noun> <maml:description> <maml:para>Custom Group description</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Custom Group description</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscustomgroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of custom group</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>ResourceKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Policy</maml:name> <maml:Description> <maml:para>Policy identifier</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>AutoResolveMembership</maml:name> <maml:Description> <maml:para>Automatically update membership</maml:para> </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>MembershipDefinition</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomGroupMembership</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomGroupMembership</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></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>Identifier of custom group</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>ResourceKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Policy</maml:name> <maml:Description> <maml:para>Policy identifier</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>AutoResolveMembership</maml:name> <maml:Description> <maml:para>Automatically update membership</maml:para> </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>MembershipDefinition</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CustomGroupMembership</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CustomGroupMembership</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $CustomGroupProperty = Initialize-VcfOpsCustomGroupProperty -Name "MyName" -Type "STRING" -InclusionValue "MyInclusionValue" -ExclusionValue "MyExclusionValue" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $PropertyStatConditionRule = Initialize-VcfOpsPropertyStatConditionRule -Key "MyKey" -StringValue "MyStringValue" -DoubleValue 0 -CompareOperator "EQ" $ResourceNameConditionRule = Initialize-VcfOpsResourceNameConditionRule -Name "MyName" -CompareOperator "EQ" $RelationshipConditionRule = Initialize-VcfOpsRelationshipConditionRule -Relation "PARENT" -Name "MyName" -CompareOperator "EQ" -TravesalSpecId "MyTravesalSpecId" $ResourceTagConditionRule = Initialize-VcfOpsResourceTagConditionRule -Category "MyCategory" -CompareOperator "EQ" -StringValue "MyStringValue" $MembershipRuleGroup = Initialize-VcfOpsMembershipRuleGroup -ResourceKindKey $ResourceKindKey -StatConditionRules $PropertyStatConditionRule -PropertyConditionRules $PropertyStatConditionRule -ResourceNameConditionRules $ResourceNameConditionRule -RelationshipConditionRules $RelationshipConditionRule -ResourceTagConditionRules $ResourceTagConditionRule $CustomGroupMembership = Initialize-VcfOpsCustomGroupMembership -IncludedResources "MyIncludedResources" -ExcludedResources "MyExcludedResources" -CustomGroupProperties $CustomGroupProperty -Rules $MembershipRuleGroup $CustomGroup = Initialize-VcfOpsCustomGroup -Id "MyId" -ResourceKey $ResourceKey -Policy "MyPolicy" -AutoResolveMembership $false -MembershipDefinition $CustomGroupMembership -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomgroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $CustomGroupMembership = Initialize-VcfOpsCustomGroupMembership $CustomGroup = Initialize-VcfOpsCustomGroup -ResourceKey $ResourceKey -MembershipDefinition $CustomGroupMembership </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomgroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CustomGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcekey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscustomgroupmembership</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-VcfOpscustomgroupmembership</command:name> <command:verb>Initialize</command:verb> <command:noun>customgroupmembership</command:noun> <maml:description> <maml:para>Custom group membership definition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Custom group membership definition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscustomgroupmembership</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludedResources</maml:name> <maml:Description> <maml:para>Collection of resources to include in the given group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ExcludedResources</maml:name> <maml:Description> <maml:para>Collection of resources to exclude from the given group. This property is useful when the group<br>membership is dynamic and you want to explicitly exclude certain set of resources even if they<br>are selected by the rule engine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>CustomGroupProperties</maml:name> <maml:Description> <maml:para>Collection of custom group properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CustomGroupProperty></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CustomGroupProperty></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rules</maml:name> <maml:Description> <maml:para>Collection of custom group rules</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.MembershipRuleGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.MembershipRuleGroup></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>IncludedResources</maml:name> <maml:Description> <maml:para>Collection of resources to include in the given group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ExcludedResources</maml:name> <maml:Description> <maml:para>Collection of resources to exclude from the given group. This property is useful when the group<br>membership is dynamic and you want to explicitly exclude certain set of resources even if they<br>are selected by the rule engine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>CustomGroupProperties</maml:name> <maml:Description> <maml:para>Collection of custom group properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.CustomGroupProperty></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.CustomGroupProperty></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rules</maml:name> <maml:Description> <maml:para>Collection of custom group rules</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.MembershipRuleGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.MembershipRuleGroup></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CustomGroupProperty = Initialize-VcfOpsCustomGroupProperty -Name "MyName" -Type "STRING" -InclusionValue "MyInclusionValue" -ExclusionValue "MyExclusionValue" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $PropertyStatConditionRule = Initialize-VcfOpsPropertyStatConditionRule -Key "MyKey" -StringValue "MyStringValue" -DoubleValue 0 -CompareOperator "EQ" $ResourceNameConditionRule = Initialize-VcfOpsResourceNameConditionRule -Name "MyName" -CompareOperator "EQ" $RelationshipConditionRule = Initialize-VcfOpsRelationshipConditionRule -Relation "PARENT" -Name "MyName" -CompareOperator "EQ" -TravesalSpecId "MyTravesalSpecId" $ResourceTagConditionRule = Initialize-VcfOpsResourceTagConditionRule -Category "MyCategory" -CompareOperator "EQ" -StringValue "MyStringValue" $MembershipRuleGroup = Initialize-VcfOpsMembershipRuleGroup -ResourceKindKey $ResourceKindKey -StatConditionRules $PropertyStatConditionRule -PropertyConditionRules $PropertyStatConditionRule -ResourceNameConditionRules $ResourceNameConditionRule -RelationshipConditionRules $RelationshipConditionRule -ResourceTagConditionRules $ResourceTagConditionRule $CustomGroupMembership = Initialize-VcfOpsCustomGroupMembership -IncludedResources "MyIncludedResources" -ExcludedResources "MyExcludedResources" -CustomGroupProperties $CustomGroupProperty -Rules $MembershipRuleGroup </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomgroupmembership with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CustomGroupMembership = Initialize-VcfOpsCustomGroupMembership </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomgroupmembership with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CustomGroupMembership</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscustomgroupproperty</command:name> <command:verb>Initialize</command:verb> <command:noun>customgroupproperty</command:noun> <maml:description> <maml:para>Represents a Custom Group Property</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a Custom Group Property</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscustomgroupproperty</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 custom group property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Custom Group property type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InclusionValue</maml:name> <maml:Description> <maml:para>The value of inclusion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExclusionValue</maml:name> <maml:Description> <maml:para>The value of exclusion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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 custom group property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Custom Group property type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InclusionValue</maml:name> <maml:Description> <maml:para>The value of inclusion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExclusionValue</maml:name> <maml:Description> <maml:para>The value of exclusion</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$CustomGroupProperty = Initialize-VcfOpsCustomGroupProperty -Name "MyName" -Type "STRING" -InclusionValue "MyInclusionValue" -ExclusionValue "MyExclusionValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomgroupproperty with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CustomGroupProperty = Initialize-VcfOpsCustomGroupProperty -Name "MyName" -Type "STRING" -InclusionValue "MyInclusionValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomgroupproperty with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CustomGroupProperty</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpscustomprofile</command:name> <command:verb>Initialize</command:verb> <command:noun>customprofile</command:noun> <maml:description> <maml:para>Custom profile details</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Custom profile details</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscustomprofile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of custom profile</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>Name</maml:name> <maml:Description> <maml:para>The name of custom 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>Description</maml:name> <maml:Description> <maml:para>The description of custom 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>ObjectType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacityConsumer</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacityConsumer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomProfileMetrics</maml:name> <maml:Description> <maml:para>Collection of profile metrics</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ProfileMetric></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ProfileMetric></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 identifier of custom profile</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>Name</maml:name> <maml:Description> <maml:para>The name of custom 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>Description</maml:name> <maml:Description> <maml:para>The description of custom 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>ObjectType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacityConsumer</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacityConsumer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CustomProfileMetrics</maml:name> <maml:Description> <maml:para>Collection of profile metrics</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ProfileMetric></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ProfileMetric></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CapacityConsumer = Initialize-VcfOpsCapacityConsumer -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" $ProfileMetric = Initialize-VcfOpsProfileMetric -Metric "MyMetric" -Value 0 -Unit "MyUnit" $CustomProfile = Initialize-VcfOpsCustomProfile -Id "MyId" -Name "MyName" -Description "MyDescription" -ObjectType $CapacityConsumer -CustomProfileMetrics $ProfileMetric </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomprofile with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $CapacityConsumer = Initialize-VcfOpsCapacityConsumer -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" $ProfileMetric = Initialize-VcfOpsProfileMetric -Metric "MyMetric" -Value 0 -Unit "MyUnit" $CustomProfile = Initialize-VcfOpsCustomProfile -Name "MyName" -ObjectType $CapacityConsumer -CustomProfileMetrics $ProfileMetric </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomprofile with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CustomProfile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscapacityconsumer</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-VcfOpscustomprofilesettings</command:name> <command:verb>Initialize</command:verb> <command:noun>customprofilesettings</command:noun> <maml:description> <maml:para>Custom Profile is a user defined virtual machine profile, to determine the number of virtual machines which will fit within the remaining capacity.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Custom Profile is a user defined virtual machine profile, to determine the number of virtual machines which will fit within the remaining capacity.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpscustomprofilesettings</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>$CustomProfileSettings = Initialize-VcfOpsCustomProfileSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomprofilesettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$CustomProfileSettings = Initialize-VcfOpsCustomProfileSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpscustomprofilesettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/CustomProfileSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsDTcondition</command:name> <command:verb>Initialize</command:verb> <command:noun>DTcondition</command:noun> <maml:description> <maml:para>The Dynamic Threshold Condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Dynamic Threshold Condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsDTcondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DTCondition = Initialize-VcfOpsDTCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsDTcondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DTCondition = Initialize-VcfOpsDTCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsDTcondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/DTCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsDTSMcondition</command:name> <command:verb>Initialize</command:verb> <command:noun>DTSMcondition</command:noun> <maml:description> <maml:para>Dynamic Threshold on Super Metrics Condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Dynamic Threshold on Super Metrics Condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsDTSMcondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DTSMCondition = Initialize-VcfOpsDTSMCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsDTSMcondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DTSMCondition = Initialize-VcfOpsDTSMCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsDTSMcondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/DTSMCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsdaterange</command:name> <command:verb>Initialize</command:verb> <command:noun>daterange</command:noun> <maml:description> <maml:para>Model to represent a date range param for searching bill summary</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model to represent a date range param for searching bill summary</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsdaterange</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Start</maml:name> <maml:Description> <maml:para>The start time of the Date Range Search</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>VarEnd</maml:name> <maml:Description> <maml:para>The end time of the Date Range Search</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>Start</maml:name> <maml:Description> <maml:para>The start time of the Date Range Search</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>VarEnd</maml:name> <maml:Description> <maml:para>The end time of the Date Range Search</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>$DateRange = Initialize-VcfOpsDateRange -Start 0 -End 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsdaterange with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DateRange = Initialize-VcfOpsDateRange -Start 0 -End 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsdaterange with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/DateRange</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsdtstatquery</command:name> <command:verb>Initialize</command:verb> <command:noun>dtstatquery</command:noun> <maml:description> <maml:para>Object used to define search criteria for retrieving Stats Data as well as Dynamic Thresholds<br>The query spec enforces that at least one Resource (Object) and at least one StatKey is specified.<br>The <i>begin</i> and <i>end</i> values that are used to specify the time window are optional. If<br>these are not specified the API returns 24 hours of Stats and DT data by default.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Object used to define search criteria for retrieving Stats Data as well as Dynamic Thresholds<br>The query spec enforces that at least one Resource (Object) and at least one StatKey is specified.<br>The <i>begin</i> and <i>end</i> values that are used to specify the time window are optional. If<br>these are not specified the API returns 24 hours of Stats and DT data by default.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsdtstatquery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Collection of Resource identifiers for which Stats and DT values need to be retrieved</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKeys</maml:name> <maml:Description> <maml:para>Collection of StatKeys for which Stats and DT values need to be retrieved</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC</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>VarEnd</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>long value is number of milliseconds since January 1, 1970 00:00:00 UTC</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>ShowSmooth</maml:name> <maml:Description> <maml:para>Flag that indicates whether stats should be smoothened or not. Default value is 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SmoothFactor</maml:name> <maml:Description> <maml:para>The smooth precision, default value is 2.0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Collection of Resource identifiers for which Stats and DT values need to be retrieved</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKeys</maml:name> <maml:Description> <maml:para>Collection of StatKeys for which Stats and DT values need to be retrieved</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC</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>VarEnd</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>long value is number of milliseconds since January 1, 1970 00:00:00 UTC</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>ShowSmooth</maml:name> <maml:Description> <maml:para>Flag that indicates whether stats should be smoothened or not. Default value is 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SmoothFactor</maml:name> <maml:Description> <maml:para>The smooth precision, default value is 2.0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DtStatQuery = Initialize-VcfOpsDtStatQuery -ResourceIds "MyResourceIds" -StatKeys "MyStatKeys" -Begin 0 -End 0 -ShowSmooth $false -SmoothFactor 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsdtstatquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DtStatQuery = Initialize-VcfOpsDtStatQuery -ResourceIds "MyResourceIds" -StatKeys "MyStatKeys" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsdtstatquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/DtStatQuery</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsemail</command:name> <command:verb>Initialize</command:verb> <command:noun>email</command:noun> <maml:description> <maml:para>Model that represents an email.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents an email.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsemail</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Subject</maml:name> <maml:Description> <maml:para>Subject of email</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>Email body. The following keys can be used for body construction and should be prefixed by $ : CREATE_TIME, UPDATE_TIME, CANCEL_TIME, ALERT_ID, ALERT_STATUS, ALERT_DEFINITION, ALERT_DEFINITION_DESCRIPTION, ALERT_RECOMMENDATIONS, RESOURCE_NAME, RESOURCE_KIND, RESOURCE_ID, ADAPTER_KIND, RESOURCE_KIND_TYPE, ALERT_IMPACT, CONTROL_STATE, ALERT_CRITICALITY, ALERT_TYPE, ALERT_SUBTYPE, OBJECT_HEALTH_STATE, OBJECT_RISK_STATE, OBJECT_EFFICIENCY_STATE, SYMPTOMS, ADAPTER_INSTANCE, LINK_TO_ALERT</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Subject</maml:name> <maml:Description> <maml:para>Subject of email</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>Email body. The following keys can be used for body construction and should be prefixed by $ : CREATE_TIME, UPDATE_TIME, CANCEL_TIME, ALERT_ID, ALERT_STATUS, ALERT_DEFINITION, ALERT_DEFINITION_DESCRIPTION, ALERT_RECOMMENDATIONS, RESOURCE_NAME, RESOURCE_KIND, RESOURCE_ID, ADAPTER_KIND, RESOURCE_KIND_TYPE, ALERT_IMPACT, CONTROL_STATE, ALERT_CRITICALITY, ALERT_TYPE, ALERT_SUBTYPE, OBJECT_HEALTH_STATE, OBJECT_RISK_STATE, OBJECT_EFFICIENCY_STATE, SYMPTOMS, ADAPTER_INSTANCE, LINK_TO_ALERT</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Email = Initialize-VcfOpsEmail -Subject "MySubject" -Body "MyBody" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsemail with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Email = Initialize-VcfOpsEmail -Body "MyBody" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsemail with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Email</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsemailformattingtemplate</command:name> <command:verb>Initialize</command:verb> <command:noun>emailformattingtemplate</command:noun> <maml:description> <maml:para>Model that represents a Email template. Either both of the updatedAlertTemplate and canceledAlertTemplate fields should be provided or neither of them. If those fields are not provided, the value of newAlertTemplate will be used while sending the notification.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents a Email template. Either both of the updatedAlertTemplate and canceledAlertTemplate fields should be provided or neither of them. If those fields are not provided, the value of newAlertTemplate will be used while sending the notification.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsemailformattingtemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {WEBHOOK_TEMPLATE, EMAIL_TEMPLATE}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {WEBHOOK_TEMPLATE, EMAIL_TEMPLATE}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$EmailFormattingTemplate = Initialize-VcfOpsEmailFormattingTemplate -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsemailformattingtemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$EmailFormattingTemplate = Initialize-VcfOpsEmailFormattingTemplate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsemailformattingtemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/EmailFormattingTemplate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsEvent</command:name> <command:verb>Initialize</command:verb> <command:noun>Event</command:noun> <maml:description> <maml:para>Class to represent external events. Different event types have different required fields.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Class to represent external events. Different event types have different required fields.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EventType</maml:name> <maml:Description> <maml:para>Represents the type of an Event.<br>All values are valid for the field <b><i>eventType</i></b> in the Event object.<br>When used in the creation of a <i>SymptomDefinition</i> the following restrictions are<br>applicable for the Conditions that are defined as part of a Symptom Definition.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>The id of the resource for the event</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>StartTimeUTC</maml:name> <maml:Description> <maml:para>The start time for the event in UTC.<br>This time must be after >= 946684800000L, or January 1, 2000. Default is 946684800000L.<br>Value is ignored for Change events.</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>CancelTimeUTC</maml:name> <maml:Description> <maml:para>Indicates that an event has been cancelled. For an externally managed event a new event with<br>the same <b><i>message</i></b> value must be sent with a cancelTime in order to cancel the<br>event.</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>Message</maml:name> <maml:Description> <maml:para>Event message, the message identifies the event in the 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>Severity</maml:name> <maml:Description> <maml:para>The Criticality level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The StatKey for the condition of the HardThreshold event</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HtType</maml:name> <maml:Description> <maml:para>The type of Metric Event or Metric Event Condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DiagnosticSubType</maml:name> <maml:Description> <maml:para>The subtype of Diagnostic Event</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationSubType</maml:name> <maml:Description> <maml:para>The subtype of Notification Event</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>The current value (not the expected value) of the metric for the HardThreshold event</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>KeyIndicator</maml:name> <maml:Description> <maml:para>Whether the HardThreshold event is a key performance indicator<br>True indicates it is a KPI. False otherwise.</maml:para> </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>ManagedExternally</maml:name> <maml:Description> <maml:para>If set to true, this event shall persist across collection cycles until another event is pushed<br>to change the status. <br>If set to false, this event will be cancelled during the next collection cycle if it is not pushed again</maml:para> </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>EventType</maml:name> <maml:Description> <maml:para>Represents the type of an Event.<br>All values are valid for the field <b><i>eventType</i></b> in the Event object.<br>When used in the creation of a <i>SymptomDefinition</i> the following restrictions are<br>applicable for the Conditions that are defined as part of a Symptom Definition.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>The id of the resource for the event</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>StartTimeUTC</maml:name> <maml:Description> <maml:para>The start time for the event in UTC.<br>This time must be after >= 946684800000L, or January 1, 2000. Default is 946684800000L.<br>Value is ignored for Change events.</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>CancelTimeUTC</maml:name> <maml:Description> <maml:para>Indicates that an event has been cancelled. For an externally managed event a new event with<br>the same <b><i>message</i></b> value must be sent with a cancelTime in order to cancel the<br>event.</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>Message</maml:name> <maml:Description> <maml:para>Event message, the message identifies the event in the 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>Severity</maml:name> <maml:Description> <maml:para>The Criticality level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The StatKey for the condition of the HardThreshold event</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HtType</maml:name> <maml:Description> <maml:para>The type of Metric Event or Metric Event Condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DiagnosticSubType</maml:name> <maml:Description> <maml:para>The subtype of Diagnostic Event</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotificationSubType</maml:name> <maml:Description> <maml:para>The subtype of Notification Event</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>The current value (not the expected value) of the metric for the HardThreshold event</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>KeyIndicator</maml:name> <maml:Description> <maml:para>Whether the HardThreshold event is a key performance indicator<br>True indicates it is a KPI. False otherwise.</maml:para> </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>ManagedExternally</maml:name> <maml:Description> <maml:para>If set to true, this event shall persist across collection cycles until another event is pushed<br>to change the status. <br>If set to false, this event will be cancelled during the next collection cycle if it is not pushed again</maml:para> </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>$Event = Initialize-VcfOpsEvent -EventType "CHANGE" -ResourceId "MyResourceId" -StartTimeUTC 0 -CancelTimeUTC 0 -Message "MyMessage" -Severity "UNKNOWN" -Key "MyKey" -HtType "EQUAL" -DiagnosticSubType "HEALTH" -NotificationSubType "LOG" -Value 0 -KeyIndicator $false -ManagedExternally $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsEvent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Event = Initialize-VcfOpsEvent -EventType "CHANGE" -ResourceId "MyResourceId" -Message "MyMessage" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsEvent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Event</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsevents</command:name> <command:verb>Initialize</command:verb> <command:noun>events</command:noun> <maml:description> <maml:para>A collection of external events</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A collection of external events</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsevents</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Event</maml:name> <maml:Description> <maml:para>Collection of events</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Event></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Event></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>Event</maml:name> <maml:Description> <maml:para>Collection of events</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Event></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Event></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Event = Initialize-VcfOpsEvent -EventType "CHANGE" -ResourceId "MyResourceId" -StartTimeUTC 0 -CancelTimeUTC 0 -Message "MyMessage" -Severity "UNKNOWN" -Key "MyKey" -HtType "EQUAL" -DiagnosticSubType "HEALTH" -NotificationSubType "LOG" -Value 0 -KeyIndicator $false -ManagedExternally $false $Events = Initialize-VcfOpsEvents -Event $Event </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsevents with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Events = Initialize-VcfOpsEvents </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsevents with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Events</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsextension</command:name> <command:verb>Initialize</command:verb> <command:noun>extension</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-VcfOpsextension</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AnyObjects</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Object></command:parameterValue> <dev:type> <maml:name>List<Object></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>AnyObjects</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Object></command:parameterValue> <dev:type> <maml:name>List<Object></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension -AnyObjects 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsextension with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Extension = Initialize-VcfOpsExtension </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsextension with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Extension</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsfaultcondition</command:name> <command:verb>Initialize</command:verb> <command:noun>faultcondition</command:noun> <maml:description> <maml:para>A Fault Event Condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A Fault Event Condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsfaultcondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$FaultCondition = Initialize-VcfOpsFaultCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsfaultcondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$FaultCondition = Initialize-VcfOpsFaultCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsfaultcondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/FaultCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsfixcostrate</command:name> <command:verb>Initialize</command:verb> <command:noun>fixcostrate</command:noun> <maml:description> <maml:para>Model representing fixed rate</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing fixed rate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsfixcostrate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$FixCostRate = Initialize-VcfOpsFixCostRate -ChargePeriod "HOURLY" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsfixcostrate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$FixCostRate = Initialize-VcfOpsFixCostRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsfixcostrate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/FixCostRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsformattingtemplate</command:name> <command:verb>Initialize</command:verb> <command:noun>formattingtemplate</command:noun> <maml:description> <maml:para>Base model for Notification formatting template.<br>For JSON the model descendants will generate with a field named \"type\" with one of the following values:<br><i> \"WEBHOOK_TEMPLATE\", \"EMAIL_TEMPLATE\"</i>. Submodels are : <br>webhook-template<br>email-formatting-template</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Base model for Notification formatting template.<br>For JSON the model descendants will generate with a field named \"type\" with one of the following values:<br><i> \"WEBHOOK_TEMPLATE\", \"EMAIL_TEMPLATE\"</i>. Submodels are : <br>webhook-template<br>email-formatting-template</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsformattingtemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {WEBHOOK_TEMPLATE, EMAIL_TEMPLATE}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {WEBHOOK_TEMPLATE, EMAIL_TEMPLATE}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$FormattingTemplate = Initialize-VcfOpsFormattingTemplate -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsformattingtemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$FormattingTemplate = Initialize-VcfOpsFormattingTemplate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsformattingtemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/FormattingTemplate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsgeolocation</command:name> <command:verb>Initialize</command:verb> <command:noun>geolocation</command:noun> <maml:description> <maml:para>Represents a geographical location on planet earth.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a geographical location on planet earth.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsgeolocation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Latitude</maml:name> <maml:Description> <maml:para>Latitude of the location.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Longitude</maml:name> <maml:Description> <maml:para>Longitude of the location.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Latitude</maml:name> <maml:Description> <maml:para>Latitude of the location.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Longitude</maml:name> <maml:Description> <maml:para>Longitude of the location.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$GeoLocation = Initialize-VcfOpsGeoLocation -Latitude 0 -Longitude 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsgeolocation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$GeoLocation = Initialize-VcfOpsGeoLocation -Latitude 0 -Longitude 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsgeolocation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/GeoLocation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsgrouptype</command:name> <command:verb>Initialize</command:verb> <command:noun>grouptype</command:noun> <maml:description> <maml:para>A Model representing a Group Type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A Model representing a Group Type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsgrouptype</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 Group 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>Key</maml:name> <maml:Description> <maml:para>Key of the Group 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>Name</maml:name> <maml:Description> <maml:para>Name of the Group 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>Key</maml:name> <maml:Description> <maml:para>Key of the Group 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>$GroupType = Initialize-VcfOpsGroupType -Name "MyName" -Key "MyKey" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsgrouptype with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$GroupType = Initialize-VcfOpsGroupType -Name "MyName" -Key "MyKey" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsgrouptype with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/GroupType</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsgrouptypes</command:name> <command:verb>Initialize</command:verb> <command:noun>grouptypes</command:noun> <maml:description> <maml:para>Represents a Collection of Group Types</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a Collection of Group Types</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsgrouptypes</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_GroupTypes</maml:name> <maml:Description> <maml:para>Collection of Group Types</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.GroupType></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.GroupType></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>_GroupTypes</maml:name> <maml:Description> <maml:para>Collection of Group Types</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.GroupType></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.GroupType></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $GroupType = Initialize-VcfOpsGroupType -Name "MyName" -Key "MyKey" $GroupTypes = Initialize-VcfOpsGroupTypes -_GroupTypes $GroupType </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsgrouptypes with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $GroupTypes = Initialize-VcfOpsGroupTypes </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsgrouptypes with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/GroupTypes</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsHTcondition</command:name> <command:verb>Initialize</command:verb> <command:noun>HTcondition</command:noun> <maml:description> <maml:para>Hard Threshold condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hard Threshold condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsHTcondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HTCondition = Initialize-VcfOpsHTCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsHTcondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HTCondition = Initialize-VcfOpsHTCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsHTcondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/HTCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsHTSMcondition</command:name> <command:verb>Initialize</command:verb> <command:noun>HTSMcondition</command:noun> <maml:description> <maml:para>Hard Threshold numeric Condition on a super metric</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hard Threshold numeric Condition on a super metric</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsHTSMcondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$HTSMCondition = Initialize-VcfOpsHTSMCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsHTSMcondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$HTSMCondition = Initialize-VcfOpsHTSMCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsHTSMcondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/HTSMCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpskeyvalue</command:name> <command:verb>Initialize</command:verb> <command:noun>keyvalue</command:noun> <maml:description> <maml:para>Model to handle arbitrary key/value entries, with XML bindings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model to handle arbitrary key/value entries, with XML bindings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpskeyvalue</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</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>Value</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>Key</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>Value</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>$KeyValue = Initialize-VcfOpsKeyValue -Key "MyKey" -Value "MyValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpskeyvalue with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$KeyValue = Initialize-VcfOpsKeyValue </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpskeyvalue with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/KeyValue</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpslateststatquery</command:name> <command:verb>Initialize</command:verb> <command:noun>lateststatquery</command:noun> <maml:description> <maml:para>Object used to request latest stats (metrics) on a collection of resources.<br>Defines search criteria as well as expected data set.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Object used to request latest stats (metrics) on a collection of resources.<br>Defines search criteria as well as expected data set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpslateststatquery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the latest stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the latest stats should be returned</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>MaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest stats.<br>Defaults to 1 so that when processing the query if it is omitted<br>the response would contain a single sample</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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the latest stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the latest stats should be returned</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>MaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest stats.<br>Defaults to 1 so that when processing the query if it is omitted<br>the response would contain a single sample</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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>$LatestStatQuery = Initialize-VcfOpsLatestStatQuery -ResourceId "MyResourceId" -StatKey "MyStatKey" -Metrics $false -CurrentOnly $false -MaxSamples 0 -WrapStatValues $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslateststatquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LatestStatQuery = Initialize-VcfOpsLatestStatQuery </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslateststatquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/LatestStatQuery</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpslink</command:name> <command:verb>Initialize</command:verb> <command:noun>link</command:noun> <maml:description> <maml:para>Represents a HTTP 'link' element.<br>It is implicit that all the link tags support http 'GET' method.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a HTTP 'link' element.<br>It is implicit that all the link tags support http 'GET' method.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpslink</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Href</maml:name> <maml:Description> <maml:para>The url part of this tag. Note that the href can be absolute or relative to the current url.<br>If the href begins with '/', then its absolute.<br>If the href begins with the protocol element(http, https), its absolute<br>Otherwise its relative.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rel</maml:name> <maml:Description> <maml:para>Represents the link's relation to its parent tag/object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>The name of the link</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the link</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Href</maml:name> <maml:Description> <maml:para>The url part of this tag. Note that the href can be absolute or relative to the current url.<br>If the href begins with '/', then its absolute.<br>If the href begins with the protocol element(http, https), its absolute<br>Otherwise its relative.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rel</maml:name> <maml:Description> <maml:para>Represents the link's relation to its parent tag/object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>The name of the link</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the link</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslink with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Link = Initialize-VcfOpsLink -Href "MyHref" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslink with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Link</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpslogcondition</command:name> <command:verb>Initialize</command:verb> <command:noun>logcondition</command:noun> <maml:description> <maml:para>Log based condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Log based condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpslogcondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LogCondition = Initialize-VcfOpsLogCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogcondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LogCondition = Initialize-VcfOpsLogCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogcondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/LogCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpslogconfiguration</command:name> <command:verb>Initialize</command:verb> <command:noun>logconfiguration</command:noun> <maml:description> <maml:para>Model representing Log Configuration Data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing Log Configuration Data</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpslogconfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RootLoggerLevel</maml:name> <maml:Description> <maml:para>The level of the root log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaxLogSize</maml:name> <maml:Description> <maml:para>This number specifies how much of log data to retain (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>Settings</maml:name> <maml:Description> <maml:para>Logs Settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.LogSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.LogSettings></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>RootLoggerLevel</maml:name> <maml:Description> <maml:para>The level of the root log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaxLogSize</maml:name> <maml:Description> <maml:para>This number specifies how much of log data to retain (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>Settings</maml:name> <maml:Description> <maml:para>Logs Settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.LogSettings></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.LogSettings></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $LogSettings = Initialize-VcfOpsLogSettings -Name "MyName" -Level "ALL" $LogConfiguration = Initialize-VcfOpsLogConfiguration -RootLoggerLevel "INFO" -MaxLogSize 0 -Settings $LogSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogconfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $LogConfiguration = Initialize-VcfOpsLogConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogconfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/LogConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpslogforwardingconfiguration</command:name> <command:verb>Initialize</command:verb> <command:noun>logforwardingconfiguration</command:noun> <maml:description> <maml:para>Represents the Log Forwarding Configuration object</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the Log Forwarding Configuration object</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpslogforwardingconfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>Indicates whether the logs should go to external log server 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Entities</maml:name> <maml:Description> <maml:para>Entities to forward the logs from</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<LogForwardingConfiguration.EntitiesEnum></command:parameterValue> <dev:type> <maml:name>List<LogForwardingConfiguration.EntitiesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VarHost</maml:name> <maml:Description> <maml:para>The host to forward the logs 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Protocol</maml:name> <maml:Description> <maml:para>Enumeration of the forwarding protocols</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>The Forwarding port<br><Note><br/><br>The port takes default value based on the protocol and whether SSL is enabled or not:<br>Protocol CFAPI, SSL disabled, Default port: 9000<br>Protocol CFAPI, SSL enabled, Default port: 9543<br>Protocol SYSLOG, SSL disabled, Default port: 514<br>Protocol SYSLOG, SSL enabled, Default port: 6514</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>UseSSL</maml:name> <maml:Description> <maml:para>Flag that indicates whether SSL protocol is used 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>SslCertPath</maml:name> <maml:Description> <maml:para>The path to certificate authority 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>The name 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>Indicates whether the logs should go to external log server 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Entities</maml:name> <maml:Description> <maml:para>Entities to forward the logs from</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<LogForwardingConfiguration.EntitiesEnum></command:parameterValue> <dev:type> <maml:name>List<LogForwardingConfiguration.EntitiesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VarHost</maml:name> <maml:Description> <maml:para>The host to forward the logs 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Protocol</maml:name> <maml:Description> <maml:para>Enumeration of the forwarding protocols</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>The Forwarding port<br><Note><br/><br>The port takes default value based on the protocol and whether SSL is enabled or not:<br>Protocol CFAPI, SSL disabled, Default port: 9000<br>Protocol CFAPI, SSL enabled, Default port: 9543<br>Protocol SYSLOG, SSL disabled, Default port: 514<br>Protocol SYSLOG, SSL enabled, Default port: 6514</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>UseSSL</maml:name> <maml:Description> <maml:para>Flag that indicates whether SSL protocol is used 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>SslCertPath</maml:name> <maml:Description> <maml:para>The path to certificate authority 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>The name 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"ANALYTICS"$LogForwardingConfiguration = Initialize-VcfOpsLogForwardingConfiguration -Enabled $false -Entities "ANALYTICS" -Host "MyHost" -Protocol "CFAPI" -Port 0 -UseSSL $false -SslCertPath "MySslCertPath" -Cluster "MyCluster" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogforwardingconfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>"ANALYTICS"$LogForwardingConfiguration = Initialize-VcfOpsLogForwardingConfiguration -Entities "ANALYTICS" -Host "MyHost" -Protocol "CFAPI" -Cluster "MyCluster" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogforwardingconfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/LogForwardingConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpslogqueryfiltercondition</command:name> <command:verb>Initialize</command:verb> <command:noun>logqueryfiltercondition</command:noun> <maml:description> <maml:para>Log query filter condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Log query filter condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpslogqueryfiltercondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConditionField</maml:name> <maml:Description> <maml:para>Condition field</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConditionValues</maml:name> <maml:Description> <maml:para>Collection of condition values</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>QueryFilterConditionOperatorType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.QueryFilterConditionOperatorType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.QueryFilterConditionOperatorType</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>ConditionField</maml:name> <maml:Description> <maml:para>Condition field</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConditionValues</maml:name> <maml:Description> <maml:para>Collection of condition values</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>QueryFilterConditionOperatorType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.QueryFilterConditionOperatorType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.QueryFilterConditionOperatorType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LogQueryFilterCondition = Initialize-VcfOpsLogQueryFilterCondition -ConditionField "MyConditionField" -ConditionValues "MyConditionValues" -QueryFilterConditionOperatorType "CONTAINS" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogqueryfiltercondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LogQueryFilterCondition = Initialize-VcfOpsLogQueryFilterCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogqueryfiltercondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/LogQueryFilterCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpslogqueryfilters</command:name> <command:verb>Initialize</command:verb> <command:noun>logqueryfilters</command:noun> <maml:description> <maml:para>Log query filters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Log query filters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpslogqueryfilters</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LogQueryFiltersOperator</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.LogQueryFiltersOperator</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LogQueryFiltersOperator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Partitions</maml:name> <maml:Description> <maml:para>Collection of partition</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>LogQueryFilterConditions</maml:name> <maml:Description> <maml:para>Collection of query filter condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.LogQueryFilterCondition></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.LogQueryFilterCondition></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>LogQueryFiltersOperator</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.LogQueryFiltersOperator</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.LogQueryFiltersOperator</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Partitions</maml:name> <maml:Description> <maml:para>Collection of partition</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>LogQueryFilterConditions</maml:name> <maml:Description> <maml:para>Collection of query filter condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.LogQueryFilterCondition></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.LogQueryFilterCondition></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $LogQueryFilterCondition = Initialize-VcfOpsLogQueryFilterCondition -ConditionField "MyConditionField" -ConditionValues "MyConditionValues" -QueryFilterConditionOperatorType "CONTAINS" $LogQueryFilters = Initialize-VcfOpsLogQueryFilters -LogQueryFiltersOperator "AND" -Partitions "MyPartitions" -LogQueryFilterConditions $LogQueryFilterCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogqueryfilters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $LogQueryFilters = Initialize-VcfOpsLogQueryFilters </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogqueryfilters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/LogQueryFilters</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpslogsettings</command:name> <command:verb>Initialize</command:verb> <command:noun>logsettings</command:noun> <maml:description> <maml:para>Logs Settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Logs Settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpslogsettings</maml:name> <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 Log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>The level of the log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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 name of the Log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Level</maml:name> <maml:Description> <maml:para>The level of the log</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$LogSettings = Initialize-VcfOpsLogSettings -Name "MyName" -Level "ALL" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogsettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LogSettings = Initialize-VcfOpsLogSettings -Name "MyName" -Level "ALL" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogsettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/LogSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpslogtriggercondition</command:name> <command:verb>Initialize</command:verb> <command:noun>logtriggercondition</command:noun> <maml:description> <maml:para>Log trigger condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Log trigger condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpslogtriggercondition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FunctionType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.FunctionType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.FunctionType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Field</maml:name> <maml:Description> <maml:para>Field for trigger condition. This field should be null when the function type is COUNT</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>Value for trigger condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperatorType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OperatorType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OperatorType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TimeInterval</maml:name> <maml:Description> <maml:para>Time interval for the trigger condition. Values are in minutes. Allowed values are {5, 15, 30, 60, 360}</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>GroupBy</maml:name> <maml:Description> <maml:para>Group by for trigger condition</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>FunctionType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.FunctionType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.FunctionType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Field</maml:name> <maml:Description> <maml:para>Field for trigger condition. This field should be null when the function type is COUNT</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>Value for trigger condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OperatorType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OperatorType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OperatorType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TimeInterval</maml:name> <maml:Description> <maml:para>Time interval for the trigger condition. Values are in minutes. Allowed values are {5, 15, 30, 60, 360}</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>GroupBy</maml:name> <maml:Description> <maml:para>Group by for trigger condition</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>$LogTriggerCondition = Initialize-VcfOpsLogTriggerCondition -FunctionType "COUNT" -Field "MyField" -Value 0 -OperatorType "GREATER_THAN" -TimeInterval 0 -GroupBy "MyGroupBy" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogtriggercondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$LogTriggerCondition = Initialize-VcfOpsLogTriggerCondition -FunctionType "COUNT" -OperatorType "GREATER_THAN" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpslogtriggercondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/LogTriggerCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsmaintenanceschedule</command:name> <command:verb>Initialize</command:verb> <command:noun>maintenanceschedule</command:noun> <maml:description> <maml:para>Represents a maintenance schedule during which resources are set to 'maintained' state. The server inturn informs the adapters that monitor these resources to stop monitoring until specified otherwise.Each maintenance schedule has an id, key and schedule. Both <i>id</i> and <i>key</i> have to be unique within the system. While <i>id</i> is automatically assigned by the server, <i>key</i> must be specified by the user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a maintenance schedule during which resources are set to 'maintained' state. The server inturn informs the adapters that monitor these resources to stop monitoring until specified otherwise.Each maintenance schedule has an id, key and schedule. Both <i>id</i> and <i>key</i> have to be unique within the system. While <i>id</i> is automatically assigned by the server, <i>key</i> must be specified by the user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsmaintenanceschedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier generated by the server for this schedule.</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>Key</maml:name> <maml:Description> <maml:para>Schedule key provided by user. Cannot be null during 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>Schedule</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Schedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Schedule</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>Identifier generated by the server for this schedule.</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>Key</maml:name> <maml:Description> <maml:para>Schedule key provided by user. Cannot be null during 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>Schedule</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Schedule</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Schedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> "UNKNOWNN""UNKNOWN"$Schedule = Initialize-VcfOpsSchedule -Hour 0 -MinuteOfTheHour 0 -Duration 0 -ScheduleType "UNKNOWN" -Recurrence 0 -DayOfTheMonth 0 -DaysOfTheMonth "MyDaysOfTheMonth" -WeeksOfTheMonth "UNKNOWNN" -DaysOfTheWeek "UNKNOWNN""UNKNOWN" -Month 0 -Months 0 -StartDate "MyStartDate" -ExpirationDate "MyExpirationDate" -TimeZone "MyTimeZone" -ExpireRuns 0 $MaintenanceSchedule = Initialize-VcfOpsMaintenanceSchedule -Id "MyId" -Key "MyKey" -Schedule $Schedule </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsmaintenanceschedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Schedule = Initialize-VcfOpsSchedule -Hour 0 -MinuteOfTheHour 0 -Duration 0 -ScheduleType "UNKNOWN" $MaintenanceSchedule = Initialize-VcfOpsMaintenanceSchedule -Key "MyKey" -Schedule $Schedule </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsmaintenanceschedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/MaintenanceSchedule</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsschedule</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-VcfOpsmembershiprulegroup</command:name> <command:verb>Initialize</command:verb> <command:noun>membershiprulegroup</command:noun> <maml:description> <maml:para>Group membership rule. Requires the resource kind key to specify a resource kind to be included in the group.<br>Optionally the included resources can be filtered by metric key/property rules, relationship rules or resource name rules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Group membership rule. Requires the resource kind key to specify a resource kind to be included in the group.<br>Optionally the included resources can be filtered by metric key/property rules, relationship rules or resource name rules.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsmembershiprulegroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKindKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKindKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatConditionRules</maml:name> <maml:Description> <maml:para>Collection of metric conditions for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.PropertyStatConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.PropertyStatConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyConditionRules</maml:name> <maml:Description> <maml:para>Collection of property conditions for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.PropertyStatConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.PropertyStatConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceNameConditionRules</maml:name> <maml:Description> <maml:para>Collection of resource name rules for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceNameConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceNameConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RelationshipConditionRules</maml:name> <maml:Description> <maml:para>Collection of relationship rules for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.RelationshipConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.RelationshipConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceTagConditionRules</maml:name> <maml:Description> <maml:para>Collection of resource tag rules for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceTagConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceTagConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKindKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKindKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatConditionRules</maml:name> <maml:Description> <maml:para>Collection of metric conditions for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.PropertyStatConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.PropertyStatConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyConditionRules</maml:name> <maml:Description> <maml:para>Collection of property conditions for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.PropertyStatConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.PropertyStatConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceNameConditionRules</maml:name> <maml:Description> <maml:para>Collection of resource name rules for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceNameConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceNameConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RelationshipConditionRules</maml:name> <maml:Description> <maml:para>Collection of relationship rules for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.RelationshipConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.RelationshipConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceTagConditionRules</maml:name> <maml:Description> <maml:para>Collection of resource tag rules for a custom group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceTagConditionRule></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceTagConditionRule></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $PropertyStatConditionRule = Initialize-VcfOpsPropertyStatConditionRule -Key "MyKey" -StringValue "MyStringValue" -DoubleValue 0 -CompareOperator "EQ" $ResourceNameConditionRule = Initialize-VcfOpsResourceNameConditionRule -Name "MyName" -CompareOperator "EQ" $RelationshipConditionRule = Initialize-VcfOpsRelationshipConditionRule -Relation "PARENT" -Name "MyName" -CompareOperator "EQ" -TravesalSpecId "MyTravesalSpecId" $ResourceTagConditionRule = Initialize-VcfOpsResourceTagConditionRule -Category "MyCategory" -CompareOperator "EQ" -StringValue "MyStringValue" $MembershipRuleGroup = Initialize-VcfOpsMembershipRuleGroup -ResourceKindKey $ResourceKindKey -StatConditionRules $PropertyStatConditionRule -PropertyConditionRules $PropertyStatConditionRule -ResourceNameConditionRules $ResourceNameConditionRule -RelationshipConditionRules $RelationshipConditionRule -ResourceTagConditionRules $ResourceTagConditionRule </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsmembershiprulegroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $MembershipRuleGroup = Initialize-VcfOpsMembershipRuleGroup -ResourceKindKey $ResourceKindKey </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsmembershiprulegroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/MembershipRuleGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcekindkey</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-VcfOpsmessageeventcondition</command:name> <command:verb>Initialize</command:verb> <command:noun>messageeventcondition</command:noun> <maml:description> <maml:para>Message Event Condition used as part of a Symptom Definition for the Event type</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Message Event Condition used as part of a Symptom Definition for the Event type</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsmessageeventcondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$MessageEventCondition = Initialize-VcfOpsMessageEventCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsmessageeventcondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$MessageEventCondition = Initialize-VcfOpsMessageEventCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsmessageeventcondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/MessageEventCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsmetriceventcondition</command:name> <command:verb>Initialize</command:verb> <command:noun>metriceventcondition</command:noun> <maml:description> <maml:para>Model object for a Metric Event Condition.<br>Implicitly maps to <b><i>EventType#HARD_THRESHOLD</i></b>.<br>The operator only allows for EXISTS conditions so specification of an operator<br>is not necessary and <i>CompareOperator.EXISTS</i> is implicitly used.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model object for a Metric Event Condition.<br>Implicitly maps to <b><i>EventType#HARD_THRESHOLD</i></b>.<br>The operator only allows for EXISTS conditions so specification of an operator<br>is not necessary and <i>CompareOperator.EXISTS</i> is implicitly used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsmetriceventcondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$MetricEventCondition = Initialize-VcfOpsMetricEventCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsmetriceventcondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$MetricEventCondition = Initialize-VcfOpsMetricEventCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsmetriceventcondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/MetricEventCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsNSXTIntegration</command:name> <command:verb>Initialize</command:verb> <command:noun>NSXTIntegration</command:noun> <maml:description> <maml:para>A model that represents NSXT integration details of VCF domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A model that represents NSXT integration details of VCF domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsNSXTIntegration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>NSXT integration 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>Trusted certificates of NSXT integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>Indicates whether NSXT enabled or not for current VCF 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>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Resource id of NSXT integration</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>CredentialId</maml:name> <maml:Description> <maml:para>NSXT credential 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>ServiceCredentialsUsed</maml:name> <maml:Description> <maml:para>Flag that indicates whether service credentials are used 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>Url</maml:name> <maml:Description> <maml:para>NSXT integration 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>Trusted certificates of NSXT integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>Indicates whether NSXT enabled or not for current VCF 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>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Resource id of NSXT integration</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>CredentialId</maml:name> <maml:Description> <maml:para>NSXT credential 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>ServiceCredentialsUsed</maml:name> <maml:Description> <maml:para>Flag that indicates whether service credentials are used 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> $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $NSXTIntegration = Initialize-VcfOpsNSXTIntegration -Url "MyUrl" -Certificates $Certificate -Enabled $false -Id "MyId" -CredentialId "MyCredentialId" -ServiceCredentialsUsed $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsNSXTIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NSXTIntegration = Initialize-VcfOpsNSXTIntegration </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsNSXTIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NSXTIntegration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsnamevalue</command:name> <command:verb>Initialize</command:verb> <command:noun>namevalue</command:noun> <maml:description> <maml:para>Represents a single name -> value tuple.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a single name -> value tuple.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsnamevalue</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>Value</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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</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>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnamevalue with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnamevalue with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NameValue</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsnamevalues</command:name> <command:verb>Initialize</command:verb> <command:noun>namevalues</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-VcfOpsnamevalues</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NameValuePairs</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></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>NameValuePairs</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $NameValues = Initialize-VcfOpsNameValues -NameValuePairs $NameValue </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnamevalues with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NameValues = Initialize-VcfOpsNameValues </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnamevalues with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NameValues</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsnamedchargedpowerstaterate</command:name> <command:verb>Initialize</command:verb> <command:noun>namedchargedpowerstaterate</command:noun> <maml:description> <maml:para>Named rate including charge on power state.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Named rate including charge on power state.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsnamedchargedpowerstaterate</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>$NamedChargedPowerStateRate = Initialize-VcfOpsNamedChargedPowerStateRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnamedchargedpowerstaterate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NamedChargedPowerStateRate = Initialize-VcfOpsNamedChargedPowerStateRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnamedchargedpowerstaterate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NamedChargedPowerStateRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsnamedrate</command:name> <command:verb>Initialize</command:verb> <command:noun>namedrate</command:noun> <maml:description> <maml:para>Base class for named rate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Base class for named rate.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsnamedrate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NamedRate = Initialize-VcfOpsNamedRate -ChargePeriod "HOURLY" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnamedrate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NamedRate = Initialize-VcfOpsNamedRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnamedrate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NamedRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsnetworkrate</command:name> <command:verb>Initialize</command:verb> <command:noun>networkrate</command:noun> <maml:description> <maml:para>Network rate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Network rate.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsnetworkrate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$NetworkRate = Initialize-VcfOpsNetworkRate -ChargePeriod "HOURLY" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnetworkrate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NetworkRate = Initialize-VcfOpsNetworkRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnetworkrate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NetworkRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsnotificationplugin</command:name> <command:verb>Initialize</command:verb> <command:noun>notificationplugin</command:noun> <maml:description> <maml:para>Plugin contains data required for a Plugin instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Plugin contains data required for a Plugin instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsnotificationplugin</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginTypeId</maml:name> <maml:Description> <maml:para>The plugin type 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>PluginId</maml:name> <maml:Description> <maml:para>The Plugin Id, cannot be null during update operations</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>Name</maml:name> <maml:Description> <maml:para>The name for the configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description for the configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>A read-only property whose value is set by the system</maml:para> </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>ConfigValues</maml:name> <maml:Description> <maml:para>The list of name value pairs for Plugin configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>Any set of untrusted certificates returned by the adapter source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginTypeId</maml:name> <maml:Description> <maml:para>The plugin type 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>PluginId</maml:name> <maml:Description> <maml:para>The Plugin Id, cannot be null during update operations</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>Name</maml:name> <maml:Description> <maml:para>The name for the configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description for the configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>A read-only property whose value is set by the system</maml:para> </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>ConfigValues</maml:name> <maml:Description> <maml:para>The list of name value pairs for Plugin configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>Any set of untrusted certificates returned by the adapter source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $NotificationPlugin = Initialize-VcfOpsNotificationPlugin -PluginTypeId "MyPluginTypeId" -PluginId "MyPluginId" -Name "MyName" -Description "MyDescription" -Enabled $false -ConfigValues $NameValue -Certificates $Certificate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnotificationplugin with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NotificationPlugin = Initialize-VcfOpsNotificationPlugin -PluginTypeId "MyPluginTypeId" -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnotificationplugin with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NotificationPlugin</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsnotificationrule</command:name> <command:verb>Initialize</command:verb> <command:noun>notificationrule</command:noun> <maml:description> <maml:para>Model that represents a notification rule.<br>VMware Cloud Foundation Operations has a rule engine that evaluates these rules against generated alerts.<br>Actions such as sending Email, HTTP callback is done based on matching rules.<br><b>NOTE:</b> resourceFilter and resourceKindFilter fields are deprecated, instead please use resourceFilters and resourceKindFilters fields respectively.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents a notification rule.<br>VMware Cloud Foundation Operations has a rule engine that evaluates these rules against generated alerts.<br>Actions such as sending Email, HTTP callback is done based on matching rules.<br><b>NOTE:</b> resourceFilter and resourceKindFilter fields are deprecated, instead please use resourceFilters and resourceKindFilters fields respectively.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsnotificationrule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of this rule, automatically assigned by the system on create</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>Name</maml:name> <maml:Description> <maml:para>Name of this rule</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginId</maml:name> <maml:Description> <maml:para>Identifier of the plugin for which this rule applies</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>Identifier that shows if the notification rule is enabled. Enabled by default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Identifier of the template.<br><b>NOTE:</b> For deprecated plugin types this field will be ignored. For all other plugin types, default templates will be used if this value is not specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertControlStates</maml:name> <maml:Description> <maml:para>Set of Alert control states that the alert is expected to be in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NotificationRule.AlertControlStatesEnum></command:parameterValue> <dev:type> <maml:name>List<NotificationRule.AlertControlStatesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertStatuses</maml:name> <maml:Description> <maml:para>Set of Alert states that the alert is expected to be in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NotificationRule.AlertStatusesEnum></command:parameterValue> <dev:type> <maml:name>List<NotificationRule.AlertStatusesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Criticalities</maml:name> <maml:Description> <maml:para>Set of Alert criticalities that the alert is expected to be in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NotificationRule.CriticalitiesEnum></command:parameterValue> <dev:type> <maml:name>List<NotificationRule.CriticalitiesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindFilter</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKindFilter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKindFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindFilters</maml:name> <maml:Description> <maml:para>Filter for the rule to be matched based on the Resource Kind for which the alert was generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKey></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKey></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFilter</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceFilter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFilters</maml:name> <maml:Description> <maml:para>Filters for the rule to be matched based on the \"Resource and its Children\" for which the Alerts were generated. This collection takes precedence over resourceFilter field.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceFilter></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceFilter></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertTypeFilters</maml:name> <maml:Description> <maml:para>Filter for the rule to match Alerts which are of the specified Alert type & Alert Subtypes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.AlertTypeFilter></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.AlertTypeFilter></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertDefinitionIdFilters</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StrValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StrValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertImpactFilters</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StrValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StrValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SendHeartbeat</maml:name> <maml:Description> <maml:para>Filter for the rule to send Alerts while they are active. Defaulted to False if nothing is provided.</maml:para> </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>Properties</maml:name> <maml:Description> <maml:para>Properties associated with the given rule. This may include information such as the email addresses of<br>receivers/etc...</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorUUId</maml:name> <maml:Description> <maml:para>Filter for the rule to match Alerts triggered on resources belonging to given collector</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>Filter for the rule to match Alerts triggered on resources belonging to given collector group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RuleType</maml:name> <maml:Description> <maml:para>Notification Rule Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActionStatuses</maml:name> <maml:Description> <maml:para>Set of Action statuses that the action is expected to be in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NotificationRule.ActionStatusesEnum></command:parameterValue> <dev:type> <maml:name>List<NotificationRule.ActionStatusesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></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>Identifier of this rule, automatically assigned by the system on create</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>Name</maml:name> <maml:Description> <maml:para>Name of this rule</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginId</maml:name> <maml:Description> <maml:para>Identifier of the plugin for which this rule applies</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>Identifier that shows if the notification rule is enabled. Enabled by default</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Identifier of the template.<br><b>NOTE:</b> For deprecated plugin types this field will be ignored. For all other plugin types, default templates will be used if this value is not specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertControlStates</maml:name> <maml:Description> <maml:para>Set of Alert control states that the alert is expected to be in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NotificationRule.AlertControlStatesEnum></command:parameterValue> <dev:type> <maml:name>List<NotificationRule.AlertControlStatesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertStatuses</maml:name> <maml:Description> <maml:para>Set of Alert states that the alert is expected to be in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NotificationRule.AlertStatusesEnum></command:parameterValue> <dev:type> <maml:name>List<NotificationRule.AlertStatusesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Criticalities</maml:name> <maml:Description> <maml:para>Set of Alert criticalities that the alert is expected to be in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NotificationRule.CriticalitiesEnum></command:parameterValue> <dev:type> <maml:name>List<NotificationRule.CriticalitiesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindFilter</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKindFilter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKindFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindFilters</maml:name> <maml:Description> <maml:para>Filter for the rule to be matched based on the Resource Kind for which the alert was generated</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKey></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKey></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFilter</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceFilter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceFilters</maml:name> <maml:Description> <maml:para>Filters for the rule to be matched based on the \"Resource and its Children\" for which the Alerts were generated. This collection takes precedence over resourceFilter field.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceFilter></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceFilter></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertTypeFilters</maml:name> <maml:Description> <maml:para>Filter for the rule to match Alerts which are of the specified Alert type & Alert Subtypes</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.AlertTypeFilter></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.AlertTypeFilter></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertDefinitionIdFilters</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StrValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StrValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AlertImpactFilters</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StrValues</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StrValues</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SendHeartbeat</maml:name> <maml:Description> <maml:para>Filter for the rule to send Alerts while they are active. Defaulted to False if nothing is provided.</maml:para> </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>Properties</maml:name> <maml:Description> <maml:para>Properties associated with the given rule. This may include information such as the email addresses of<br>receivers/etc...</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorUUId</maml:name> <maml:Description> <maml:para>Filter for the rule to match Alerts triggered on resources belonging to given collector</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>Filter for the rule to match Alerts triggered on resources belonging to given collector group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RuleType</maml:name> <maml:Description> <maml:para>Notification Rule Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActionStatuses</maml:name> <maml:Description> <maml:para>Set of Action statuses that the action is expected to be in</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<NotificationRule.ActionStatusesEnum></command:parameterValue> <dev:type> <maml:name>List<NotificationRule.ActionStatusesEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>"OPEN""NEW""UNKNOWN" $ResourceKindFilter = Initialize-VcfOpsResourceKindFilter -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceFilter = Initialize-VcfOpsResourceFilter -ResourceId "MyResourceId" -MatchResourceIdOnly $false -ChildrenResourceKindFilters "MyChildrenResourceKindFilters" -ChildrenResourceKindKeyFilters $ResourceKindKey -Relationship "PARENT" $AlertTypeFilter = Initialize-VcfOpsAlertTypeFilter -AlertType 0 -AlertSubTypes 0 $StrValues = Initialize-VcfOpsStrValues -Values "MyValues" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" "SUCCEEDED"$Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $NotificationRule = Initialize-VcfOpsNotificationRule -Id "MyId" -Name "MyName" -PluginId "MyPluginId" -Enabled $false -TemplateId "MyTemplateId" -AlertControlStates "OPEN" -AlertStatuses "OPEN""NEW" -Criticalities "OPEN""NEW""UNKNOWN" -ResourceKindFilter $ResourceKindFilter -ResourceKindFilters $ResourceKindKey -ResourceFilter $ResourceFilter -ResourceFilters $ResourceFilter -AlertTypeFilters $AlertTypeFilter -AlertDefinitionIdFilters $StrValues -AlertImpactFilters $StrValues -SendHeartbeat $false -Properties $NameValue -CollectorUUId "MyCollectorUUId" -CollectorGroupId "MyCollectorGroupId" -RuleType "ALERT" -ActionStatuses "OPEN""NEW""UNKNOWN" $ResourceKindFilter = Initialize-VcfOpsResourceKindFilter -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceFilter = Initialize-VcfOpsResourceFilter -ResourceId "MyResourceId" -MatchResourceIdOnly $false -ChildrenResourceKindFilters "MyChildrenResourceKindFilters" -ChildrenResourceKindKeyFilters $ResourceKindKey -Relationship "PARENT" $AlertTypeFilter = Initialize-VcfOpsAlertTypeFilter -AlertType 0 -AlertSubTypes 0 $StrValues = Initialize-VcfOpsStrValues -Values "MyValues" $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" "SUCCEEDED" -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnotificationrule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NotificationRule = Initialize-VcfOpsNotificationRule -Name "MyName" -PluginId "MyPluginId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnotificationrule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NotificationRule</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsResourceKindFilter</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsResourceFilter</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsstrvalues</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsstrvalues</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-VcfOpsnotificationtemplate</command:name> <command:verb>Initialize</command:verb> <command:noun>notificationtemplate</command:noun> <maml:description> <maml:para>Model that represents a notification template.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents a notification template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsnotificationtemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TemplateId</maml:name> <maml:Description> <maml:para>Notification template 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginTypeId</maml:name> <maml:Description> <maml:para>Notification template 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>Name</maml:name> <maml:Description> <maml:para>Name of the Notification template</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Notification template</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LastModifiedBy</maml:name> <maml:Description> <maml:para>Latest user UUID which modified the template</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LastModifiedOn</maml:name> <maml:Description> <maml:para>Last time the template is modified</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>ContentConfigs</maml:name> <maml:Description> <maml:para>A set of template content configs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TemplateContentConfig></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TemplateContentConfig></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FormattingTemplate</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfFormattingTemplate</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfFormattingTemplate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TemplateProperties</maml:name> <maml:Description> <maml:para>Collection of template properties. Applicable only for WebhookPlugin and EmailPlugin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TemplateProperty></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TemplateProperty></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AttachedRuleCount</maml:name> <maml:Description> <maml:para>Attached rule count of the Notification template</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>Editable</maml:name> <maml:Description> <maml:para>Indicates whether the template is editable 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>TemplateType</maml:name> <maml:Description> <maml:para>Notification Template Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>TemplateId</maml:name> <maml:Description> <maml:para>Notification template 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PluginTypeId</maml:name> <maml:Description> <maml:para>Notification template 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>Name</maml:name> <maml:Description> <maml:para>Name of the Notification template</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Notification template</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LastModifiedBy</maml:name> <maml:Description> <maml:para>Latest user UUID which modified the template</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LastModifiedOn</maml:name> <maml:Description> <maml:para>Last time the template is modified</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>ContentConfigs</maml:name> <maml:Description> <maml:para>A set of template content configs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TemplateContentConfig></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TemplateContentConfig></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FormattingTemplate</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfFormattingTemplate</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfFormattingTemplate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TemplateProperties</maml:name> <maml:Description> <maml:para>Collection of template properties. Applicable only for WebhookPlugin and EmailPlugin.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TemplateProperty></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TemplateProperty></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AttachedRuleCount</maml:name> <maml:Description> <maml:para>Attached rule count of the Notification template</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>Editable</maml:name> <maml:Description> <maml:para>Indicates whether the template is editable 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>TemplateType</maml:name> <maml:Description> <maml:para>Notification Template Type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKeyStats = Initialize-VcfOpsResourceKindKeyStats -ResourceKindKey $ResourceKindKey -Stats "MyStats" $TemplateContentConfig = Initialize-VcfOpsTemplateContentConfig -BaseResourceKindKeyStats $ResourceKindKeyStats -AncestorResourceKindKeys $ResourceKindKeyStats -DescendantResourceKindKeys $ResourceKindKeyStats $OneOfFormattingTemplate = Initialize-VcfOpsOneOfFormattingTemplate $TemplateProperty = Initialize-VcfOpsTemplateProperty -Key "MyKey" -Name "MyName" -Type "STRING" -Description "MyDescription" $NotificationTemplate = Initialize-VcfOpsNotificationTemplate -TemplateId "MyTemplateId" -PluginTypeId "MyPluginTypeId" -Name "MyName" -Description "MyDescription" -LastModifiedBy "MyLastModifiedBy" -LastModifiedOn 0 -ContentConfigs $TemplateContentConfig -FormattingTemplate $OneOfFormattingTemplate -TemplateProperties $TemplateProperty -AttachedRuleCount 0 -Editable $false -TemplateType "ALERT" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnotificationtemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $NotificationTemplate = Initialize-VcfOpsNotificationTemplate -PluginTypeId "MyPluginTypeId" -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnotificationtemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NotificationTemplate</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsOneOfFormattingTemplate</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-VcfOpsnumericpropertycondition</command:name> <command:verb>Initialize</command:verb> <command:noun>numericpropertycondition</command:noun> <maml:description> <maml:para>Numeric Property condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Numeric Property condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsnumericpropertycondition</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>$NumericPropertyCondition = Initialize-VcfOpsNumericPropertyCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnumericpropertycondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$NumericPropertyCondition = Initialize-VcfOpsNumericPropertyCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsnumericpropertycondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/NumericPropertyCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsOneOfBasicChargesSetting</command:name> <command:verb>Initialize</command:verb> <command:noun>OneOfBasicChargesSetting</command:noun> <maml:description> <maml:para>Basic charges settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Basic charges settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsOneOfBasicChargesSetting</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>$OneOfBasicChargesSetting = Initialize-VcfOpsOneOfBasicChargesSetting </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfBasicChargesSetting with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfBasicChargesSetting = Initialize-VcfOpsOneOfBasicChargesSetting </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfBasicChargesSetting with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/OneOfBasicChargesSetting</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsOneOfCondition</command:name> <command:verb>Initialize</command:verb> <command:noun>OneOfCondition</command:noun> <maml:description> <maml:para>Condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsOneOfCondition</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>$OneOfCondition = Initialize-VcfOpsOneOfCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfCondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfCondition = Initialize-VcfOpsOneOfCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfCondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/OneOfCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsOneOfFormattingTemplate</command:name> <command:verb>Initialize</command:verb> <command:noun>OneOfFormattingTemplate</command:noun> <maml:description> <maml:para>Formatting template</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Formatting template</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsOneOfFormattingTemplate</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>$OneOfFormattingTemplate = Initialize-VcfOpsOneOfFormattingTemplate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfFormattingTemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfFormattingTemplate = Initialize-VcfOpsOneOfFormattingTemplate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfFormattingTemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/OneOfFormattingTemplate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsOneOfNamedRate</command:name> <command:verb>Initialize</command:verb> <command:noun>OneOfNamedRate</command:noun> <maml:description> <maml:para>Named Rate</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Named Rate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsOneOfNamedRate</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>$OneOfNamedRate = Initialize-VcfOpsOneOfNamedRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfNamedRate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfNamedRate = Initialize-VcfOpsOneOfNamedRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfNamedRate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/OneOfNamedRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsOneOfSymptomSet</command:name> <command:verb>Initialize</command:verb> <command:noun>OneOfSymptomSet</command:noun> <maml:description> <maml:para>Base symptom set</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Base symptom set</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsOneOfSymptomSet</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>$OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfSymptomSet with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfSymptomSet = Initialize-VcfOpsOneOfSymptomSet </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfSymptomSet with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/OneOfSymptomSet</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsOneOfTagBasedRate</command:name> <command:verb>Initialize</command:verb> <command:noun>OneOfTagBasedRate</command:noun> <maml:description> <maml:para>Tag Based Rate</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Tag Based Rate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsOneOfTagBasedRate</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>$OneOfTagBasedRate = Initialize-VcfOpsOneOfTagBasedRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfTagBasedRate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OneOfTagBasedRate = Initialize-VcfOpsOneOfTagBasedRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsOneOfTagBasedRate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/OneOfTagBasedRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsoverallchargessettings</command:name> <command:verb>Initialize</command:verb> <command:noun>overallchargessettings</command:noun> <maml:description> <maml:para>Model representing overall charges settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing overall charges settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsoverallchargessettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$OverallChargesSettings = Initialize-VcfOpsOverallChargesSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsoverallchargessettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$OverallChargesSettings = Initialize-VcfOpsOverallChargesSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsoverallchargessettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/OverallChargesSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspasswordchange</command:name> <command:verb>Initialize</command:verb> <command:noun>passwordchange</command:noun> <maml:description> <maml:para>Model object that encapsulates information to change the password of a local VMware Cloud Foundation Operations user account</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model object that encapsulates information to change the password of a local VMware Cloud Foundation Operations user account</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspasswordchange</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CurrentPassword</maml:name> <maml:Description> <maml:para>The current 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>NewPassword</maml:name> <maml:Description> <maml:para>The new 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>CurrentPassword</maml:name> <maml:Description> <maml:para>The current 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>NewPassword</maml:name> <maml:Description> <maml:para>The new 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>$PasswordChange = Initialize-VcfOpsPasswordChange -CurrentPassword "MyCurrentPassword" -NewPassword "MyNewPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspasswordchange with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PasswordChange = Initialize-VcfOpsPasswordChange -CurrentPassword "MyCurrentPassword" -NewPassword "MyNewPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspasswordchange with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PasswordChange</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspolicy</command:name> <command:verb>Initialize</command:verb> <command:noun>policy</command:noun> <maml:description> <maml:para>Model object for creating a policy</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model object for creating a policy</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspolicy</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 Policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Name of the Policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParentPolicy</maml:name> <maml:Description> <maml:para>Parent Policy 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>Id</maml:name> <maml:Description> <maml:para>Identifier of the Policy</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>Name</maml:name> <maml:Description> <maml:para>Name of the Policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Name of the Policy</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParentPolicy</maml:name> <maml:Description> <maml:para>Parent Policy 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>Id</maml:name> <maml:Description> <maml:para>Identifier of the Policy</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$Policy = Initialize-VcfOpsPolicy -Name "MyName" -Description "MyDescription" -ParentPolicy "MyParentPolicy" -Id "MyId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicy with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Policy = Initialize-VcfOpsPolicy -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicy with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Policy</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspolicyassignmentparam</command:name> <command:verb>Initialize</command:verb> <command:noun>policyassignmentparam</command:noun> <maml:description> <maml:para>Model representing params for policy assignment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing params for policy assignment</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspolicyassignmentparam</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupIds</maml:name> <maml:Description> <maml:para>Custom group ids, for policy assignment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceAssignments</maml:name> <maml:Description> <maml:para>Resource params for policy assignment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceAssignment></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceAssignment></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>GroupIds</maml:name> <maml:Description> <maml:para>Custom group ids, for policy assignment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceAssignments</maml:name> <maml:Description> <maml:para>Resource params for policy assignment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceAssignment></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceAssignment></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceAssignment = Initialize-VcfOpsResourceAssignment -ResourceId "MyResourceId" -Depth 0 $PolicyAssignmentParam = Initialize-VcfOpsPolicyAssignmentParam -GroupIds "MyGroupIds" -ResourceAssignments $ResourceAssignment </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicyassignmentparam with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PolicyAssignmentParam = Initialize-VcfOpsPolicyAssignmentParam </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicyassignmentparam with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PolicyAssignmentParam</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspolicygroups</command:name> <command:verb>Initialize</command:verb> <command:noun>policygroups</command:noun> <maml:description> <maml:para>Model object containing information on policy and associated groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model object containing information on policy and associated groups</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspolicygroups</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Policy Identifier</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>Groups</maml:name> <maml:Description> <maml:para>Collection of groups to which the policy should be applied</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Policy Identifier</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>Groups</maml:name> <maml:Description> <maml:para>Collection of groups to which the policy should be applied</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PolicyGroups = Initialize-VcfOpsPolicyGroups -Id "MyId" -Groups "MyGroups" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicygroups with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PolicyGroups = Initialize-VcfOpsPolicyGroups -Id "MyId" -Groups "MyGroups" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicygroups with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PolicyGroups</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspolicypriorities</command:name> <command:verb>Initialize</command:verb> <command:noun>policypriorities</command:noun> <maml:description> <maml:para>Model representing policy priorities.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing policy priorities.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspolicypriorities</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyIds</maml:name> <maml:Description> <maml:para>Policy ids prioritized according to input order. This field should contain all active policy ids (except default policy).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>PolicyIds</maml:name> <maml:Description> <maml:para>Policy ids prioritized according to input order. This field should contain all active policy ids (except default policy).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PolicyPriorities = Initialize-VcfOpsPolicyPriorities -PolicyIds "MyPolicyIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicypriorities with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PolicyPriorities = Initialize-VcfOpsPolicyPriorities -PolicyIds "MyPolicyIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicypriorities with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PolicyPriorities</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspolicysettings</command:name> <command:verb>Initialize</command:verb> <command:noun>policysettings</command:noun> <maml:description> <maml:para>Model object containing policy settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model object containing policy settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspolicysettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcPricingSettings</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcPricingSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcPricingSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WorkloadAutomationSettings</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.WorkloadAutomationSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.WorkloadAutomationSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CapacitySettings</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacitySettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacitySettings</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>VcPricingSettings</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcPricingSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcPricingSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WorkloadAutomationSettings</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.WorkloadAutomationSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.WorkloadAutomationSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CapacitySettings</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CapacitySettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CapacitySettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PricingPolicyStatusSettings = Initialize-VcfOpsPricingPolicyStatusSettings -PolicyId "MyPolicyId" -Inherited $false $OneOfBasicChargesSetting = Initialize-VcfOpsOneOfBasicChargesSetting $VcGuestOsRateSettings = Initialize-VcfOpsVcGuestOsRateSettings -PolicyId "MyPolicyId" -Inherited $false $PricingTagsSettings = Initialize-VcfOpsPricingTagsSettings -PolicyId "MyPolicyId" -Inherited $false $OverallChargesSettings = Initialize-VcfOpsOverallChargesSettings -PolicyId "MyPolicyId" -Inherited $false $VcPricingSettings = Initialize-VcfOpsVcPricingSettings -PricingPolicyStatus $PricingPolicyStatusSettings -BasicCharges $OneOfBasicChargesSetting -GuestOSRate $VcGuestOsRateSettings -Tags $PricingTagsSettings -OverallCharges $OverallChargesSettings $WorkloadOptimizationSettings = Initialize-VcfOpsWorkloadOptimizationSettings -PolicyId "MyPolicyId" -Inherited $false $ClusterHeadroomSettings = Initialize-VcfOpsClusterHeadroomSettings -PolicyId "MyPolicyId" -Inherited $false $ChangeDatastoreSettings = Initialize-VcfOpsChangeDatastoreSettings -PolicyId "MyPolicyId" -Inherited $false $TargetNetworkSettings = Initialize-VcfOpsTargetNetworkSettings -PolicyId "MyPolicyId" -Inherited $false $WorkloadAutomationSettings = Initialize-VcfOpsWorkloadAutomationSettings -WorkloadOptimization $WorkloadOptimizationSettings -ClusterHeadroom $ClusterHeadroomSettings -ChangeDatastore $ChangeDatastoreSettings -TargetNetwork $TargetNetworkSettings $CapacityAllocationSettings = Initialize-VcfOpsCapacityAllocationSettings $CustomProfileSettings = Initialize-VcfOpsCustomProfileSettings $CapacityBufferSettings = Initialize-VcfOpsCapacityBufferSettings $Capacity = Initialize-VcfOpsCapacity -CapacityAllocationSettings $CapacityAllocationSettings -CustomProfileSettings $CustomProfileSettings -CapacityBufferSettings $CapacityBufferSettings $CriticalityThresholdsSettings = Initialize-VcfOpsCriticalityThresholdsSettings $CriticalityThresholds = Initialize-VcfOpsCriticalityThresholds -TimeRemainingSettings $CriticalityThresholdsSettings -CapacityRemainingSettings $CriticalityThresholdsSettings -WorkloadSettings $CriticalityThresholdsSettings $CapacitySettings = Initialize-VcfOpsCapacitySettings -Capacity $Capacity -CriticalityThresholds $CriticalityThresholds $PolicySettings = Initialize-VcfOpsPolicySettings -VcPricingSettings $VcPricingSettings -WorkloadAutomationSettings $WorkloadAutomationSettings -CapacitySettings $CapacitySettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicysettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PolicySettings = Initialize-VcfOpsPolicySettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicysettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PolicySettings</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsvcpricingsettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsworkloadautomationsettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscapacitysettings</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-VcfOpspolicysettingselement</command:name> <command:verb>Initialize</command:verb> <command:noun>policysettingselement</command:noun> <maml:description> <maml:para>Model representing policy settings element.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing policy settings element.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspolicysettingselement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$PolicySettingsElement = Initialize-VcfOpsPolicySettingsElement -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicysettingselement with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PolicySettingsElement = Initialize-VcfOpsPolicySettingsElement </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicysettingselement with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PolicySettingsElement</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspolicyunassignmentparam</command:name> <command:verb>Initialize</command:verb> <command:noun>policyunassignmentparam</command:noun> <maml:description> <maml:para>Model representing params for policy unassignment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing params for policy unassignment</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspolicyunassignmentparam</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GroupIds</maml:name> <maml:Description> <maml:para>Custom group ids, for policy unassignment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceIds</maml:name> <maml:Description> <maml:para>Resource ids, for policy unassignment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<Guid></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>GroupIds</maml:name> <maml:Description> <maml:para>Custom group ids, for policy unassignment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceIds</maml:name> <maml:Description> <maml:para>Resource ids, for policy unassignment</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PolicyUnassignmentParam = Initialize-VcfOpsPolicyUnassignmentParam -GroupIds "MyGroupIds" -ResourceIds "MyResourceIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicyunassignmentparam with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PolicyUnassignmentParam = Initialize-VcfOpsPolicyUnassignmentParam </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspolicyunassignmentparam with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PolicyUnassignmentParam</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspricingpolicystatussettings</command:name> <command:verb>Initialize</command:verb> <command:noun>pricingpolicystatussettings</command:noun> <maml:description> <maml:para>Model representing VC pricing policy status settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing VC pricing policy status settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspricingpolicystatussettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$PricingPolicyStatusSettings = Initialize-VcfOpsPricingPolicyStatusSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspricingpolicystatussettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PricingPolicyStatusSettings = Initialize-VcfOpsPricingPolicyStatusSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspricingpolicystatussettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PricingPolicyStatusSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspricingtagssettings</command:name> <command:verb>Initialize</command:verb> <command:noun>pricingtagssettings</command:noun> <maml:description> <maml:para>Model representing VC Pricing tags settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing VC Pricing tags settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspricingtagssettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$PricingTagsSettings = Initialize-VcfOpsPricingTagsSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspricingtagssettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PricingTagsSettings = Initialize-VcfOpsPricingTagsSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspricingtagssettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PricingTagsSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsprivilegekeys</command:name> <command:verb>Initialize</command:verb> <command:noun>privilegekeys</command:noun> <maml:description> <maml:para>List of only the Privilege key values</maml:para> </maml:description> </command:details> <maml:description> <maml:para>List of only the Privilege key values</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsprivilegekeys</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrivilegeKey</maml:name> <maml:Description> <maml:para>Collection of privilege keys</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>PrivilegeKey</maml:name> <maml:Description> <maml:para>Collection of privilege keys</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>$PrivilegeKeys = Initialize-VcfOpsPrivilegeKeys -PrivilegeKey "MyPrivilegeKey" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsprivilegekeys with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PrivilegeKeys = Initialize-VcfOpsPrivilegeKeys -PrivilegeKey "MyPrivilegeKey" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsprivilegekeys with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PrivilegeKeys</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsprofilemetric</command:name> <command:verb>Initialize</command:verb> <command:noun>profilemetric</command:noun> <maml:description> <maml:para>Metric details of custom profile</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Metric details of custom profile</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsprofilemetric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Metric</maml:name> <maml:Description> <maml:para>The name of the metric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The value of the metric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Unit</maml:name> <maml:Description> <maml:para>The unit of the metric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Metric</maml:name> <maml:Description> <maml:para>The name of the metric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The value of the metric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Unit</maml:name> <maml:Description> <maml:para>The unit of the metric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ProfileMetric = Initialize-VcfOpsProfileMetric -Metric "MyMetric" -Value 0 -Unit "MyUnit" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsprofilemetric with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ProfileMetric = Initialize-VcfOpsProfileMetric -Metric "MyMetric" -Value 0 -Unit "MyUnit" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsprofilemetric with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ProfileMetric</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsproperties</command:name> <command:verb>Initialize</command:verb> <command:noun>properties</command:noun> <maml:description> <maml:para>Represents a collection of auth source type properties</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a collection of auth source type properties</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsproperties</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Property</maml:name> <maml:Description> <maml:para>Collection of auth source type properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.AuthSourceProperty></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.AuthSourceProperty></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>Property</maml:name> <maml:Description> <maml:para>Collection of auth source type properties</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.AuthSourceProperty></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.AuthSourceProperty></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $AuthSourceProperty = Initialize-VcfOpsAuthSourceProperty -Name "MyName" -DataType "STRING" -Description "MyDescription" -Required $false -Modifiable $false $Properties = Initialize-VcfOpsProperties -Property $AuthSourceProperty </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsproperties with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Properties = Initialize-VcfOpsProperties </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsproperties with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Properties</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspropertiesquery</command:name> <command:verb>Initialize</command:verb> <command:noun>propertiesquery</command:noun> <maml:description> <maml:para>Object used to request properties on a collection of resources</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Object used to request properties on a collection of resources</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspropertiesquery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Array of resource ids to fetch the properties for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>PropertyKeys</maml:name> <maml:Description> <maml:para>Array of property keys to fetch the latest values for</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>Instanced</maml:name> <maml:Description> <maml:para>Indicates whether specified property keys of query should be forcibly treated as instanced properties</maml:para> </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>ResourceIds</maml:name> <maml:Description> <maml:para>Array of resource ids to fetch the properties for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>PropertyKeys</maml:name> <maml:Description> <maml:para>Array of property keys to fetch the latest values for</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>Instanced</maml:name> <maml:Description> <maml:para>Indicates whether specified property keys of query should be forcibly treated as instanced properties</maml:para> </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>$PropertiesQuery = Initialize-VcfOpsPropertiesQuery -ResourceIds "MyResourceIds" -PropertyKeys "MyPropertyKeys" -Instanced $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspropertiesquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PropertiesQuery = Initialize-VcfOpsPropertiesQuery -ResourceIds "MyResourceIds" -PropertyKeys "MyPropertyKeys" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspropertiesquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PropertiesQuery</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsPropertyCondition</command:name> <command:verb>Initialize</command:verb> <command:noun>PropertyCondition</command:noun> <maml:description> <maml:para>Base class for Property Conditions. For JSON the class descendants will generate with a field named 'type' with one of the following values: CONDITION_PROPERTY_STRING, CONDITION_PROPERTY_NUMERIC</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Base class for Property Conditions. For JSON the class descendants will generate with a field named 'type' with one of the following values: CONDITION_PROPERTY_STRING, CONDITION_PROPERTY_NUMERIC</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsPropertyCondition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CONDITION_HT, CONDITION_HT_SUPER, CONDITION_DT, CONDITION_DT_SUPER, CONDITION_PROPERTY, CONDITION_PROPERTY_NUMERIC, CONDITION_PROPERTY_STRING, CONDITION_FAULT, CONDITION_MESSAGE_EVENT, CONDITION_METRIC_EVENT, CONDITION_LOG}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PropertyCondition = Initialize-VcfOpsPropertyCondition -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsPropertyCondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PropertyCondition = Initialize-VcfOpsPropertyCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsPropertyCondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PropertyCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspropertycontent</command:name> <command:verb>Initialize</command:verb> <command:noun>propertycontent</command:noun> <maml:description> <maml:para>Represents the Property Content posted by the user.<br>The data posted by the user can be numeric data or string data.<br>However both types of the data cannot be sent together.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the Property Content posted by the user.<br>The data posted by the user can be numeric data or string data.<br>However both types of the data cannot be sent together.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspropertycontent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKey</maml:name> <maml:Description> <maml:para>Stat Key for which the data is being posted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Timestamps</maml:name> <maml:Description> <maml:para>The array of timestamps at which the data is being posted. All the timestamps must be in milliseconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<long></command:parameterValue> <dev:type> <maml:name>List<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>Data</maml:name> <maml:Description> <maml:para>The array of numeric data that is being posted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<double></command:parameterValue> <dev:type> <maml:name>List<double></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Values</maml:name> <maml:Description> <maml:para>The array of string values that are being posted</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>StatKey</maml:name> <maml:Description> <maml:para>Stat Key for which the data is being posted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Timestamps</maml:name> <maml:Description> <maml:para>The array of timestamps at which the data is being posted. All the timestamps must be in milliseconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<long></command:parameterValue> <dev:type> <maml:name>List<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>Data</maml:name> <maml:Description> <maml:para>The array of numeric data that is being posted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<double></command:parameterValue> <dev:type> <maml:name>List<double></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Values</maml:name> <maml:Description> <maml:para>The array of string values that are being posted</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>$PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspropertycontent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspropertycontent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PropertyContent</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspropertycontents</command:name> <command:verb>Initialize</command:verb> <command:noun>propertycontents</command:noun> <maml:description> <maml:para>Represents the Property Contents posted by the user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the Property Contents posted by the user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspropertycontents</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyContent</maml:name> <maml:Description> <maml:para>Collection of property contents</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.PropertyContent></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.PropertyContent></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyContent</maml:name> <maml:Description> <maml:para>Collection of property contents</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.PropertyContent></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.PropertyContent></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspropertycontents with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspropertycontents with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PropertyContents</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpspropertystatconditionrule</command:name> <command:verb>Initialize</command:verb> <command:noun>propertystatconditionrule</command:noun> <maml:description> <maml:para>Condition on the metric or property key. Value is either a string or double.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Condition on the metric or property key. Value is either a string or double.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpspropertystatconditionrule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>Key for the property or stat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StringValue</maml:name> <maml:Description> <maml:para>String value of the condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DoubleValue</maml:name> <maml:Description> <maml:para>Double value of the condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompareOperator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>Key for the property or stat</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StringValue</maml:name> <maml:Description> <maml:para>String value of the condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DoubleValue</maml:name> <maml:Description> <maml:para>Double value of the condition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompareOperator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PropertyStatConditionRule = Initialize-VcfOpsPropertyStatConditionRule -Key "MyKey" -StringValue "MyStringValue" -DoubleValue 0 -CompareOperator "EQ" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspropertystatconditionrule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PropertyStatConditionRule = Initialize-VcfOpsPropertyStatConditionRule -Key "MyKey" -CompareOperator "EQ" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpspropertystatconditionrule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/PropertyStatConditionRule</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsratebasicchargessettings</command:name> <command:verb>Initialize</command:verb> <command:noun>ratebasicchargessettings</command:noun> <maml:description> <maml:para>Model representing VC basic charges settings based on rate</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing VC basic charges settings based on rate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsratebasicchargessettings</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>$RateBasicChargesSettings = Initialize-VcfOpsRateBasicChargesSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsratebasicchargessettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RateBasicChargesSettings = Initialize-VcfOpsRateBasicChargesSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsratebasicchargessettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/RateBasicChargesSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsrecommendation</command:name> <command:verb>Initialize</command:verb> <command:noun>recommendation</command:noun> <maml:description> <maml:para>The <i>Recommendation</i> encapsulates information and possible action needed to resolve a problem in the system.<br>The <i>Recommendation</i> optionally includes a <i>RecommendedAction</i>.<br><p> In other words, a recommendation may have textual data and no associated action<br>or it can have both.<br>The <i>Recommendation</i> is uniquely identified by an identifier<br>which is generated by the system during its creation.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The <i>Recommendation</i> encapsulates information and possible action needed to resolve a problem in the system.<br>The <i>Recommendation</i> optionally includes a <i>RecommendedAction</i>.<br><p> In other words, a recommendation may have textual data and no associated action<br>or it can have both.<br>The <i>Recommendation</i> is uniquely identified by an identifier<br>which is generated by the system during its creation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsrecommendation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The recommendation id. Must be null during creation (System generated 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The description for the recommendation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Action</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.RecommendedAction</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RecommendedAction</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 recommendation id. Must be null during creation (System generated 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The description for the recommendation</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Action</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.RecommendedAction</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RecommendedAction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $RecommendedAction = Initialize-VcfOpsRecommendedAction -ActionAdapterKindId "MyActionAdapterKindId" -TargetAdapterKindId "MyTargetAdapterKindId" -TargetResourceKindId "MyTargetResourceKindId" -TargetMethod "MyTargetMethod" $Recommendation = Initialize-VcfOpsRecommendation -Id "MyId" -Description "MyDescription" -Action $RecommendedAction </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrecommendation with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Recommendation = Initialize-VcfOpsRecommendation -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrecommendation with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Recommendation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsrecommendedaction</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-VcfOpsrecommendedaction</command:name> <command:verb>Initialize</command:verb> <command:noun>recommendedaction</command:noun> <maml:description> <maml:para>Identifies an action the system may take to solve a problem.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Identifies an action the system may take to solve a problem.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsrecommendedaction</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActionAdapterKindId</maml:name> <maml:Description> <maml:para>The Adapter Kind that defined this Recommended Action<br>An example could be the Out-of-the-box Remediation Adapter Kind ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetAdapterKindId</maml:name> <maml:Description> <maml:para>The Adapter Kind for which this Recommended Action is applicable.<br>An example could be the Out-of-the-box VC Adapter Kind ID viz. \"VMWARE\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetResourceKindId</maml:name> <maml:Description> <maml:para>Resource Kind of the Adapter Kind <i>targetAdapterKindId</i><br>on which this Recommended Action is applicable.<br>For certain recommended actions, this can be null.<br>The system supports a scenario where the Recommended Action is only<br>associated with <i>targetAdapterKindId</i> only.<br>An example could be the Out-of-the-box VC Resource Kind ID viz. \"VirtualMachine\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetMethod</maml:name> <maml:Description> <maml:para>Name of the remediation action that needs to be performed on the resource<br>An example could be a few of the VM lifecycle operations viz. \"shutdown\", \"reset\" 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ActionAdapterKindId</maml:name> <maml:Description> <maml:para>The Adapter Kind that defined this Recommended Action<br>An example could be the Out-of-the-box Remediation Adapter Kind ID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetAdapterKindId</maml:name> <maml:Description> <maml:para>The Adapter Kind for which this Recommended Action is applicable.<br>An example could be the Out-of-the-box VC Adapter Kind ID viz. \"VMWARE\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetResourceKindId</maml:name> <maml:Description> <maml:para>Resource Kind of the Adapter Kind <i>targetAdapterKindId</i><br>on which this Recommended Action is applicable.<br>For certain recommended actions, this can be null.<br>The system supports a scenario where the Recommended Action is only<br>associated with <i>targetAdapterKindId</i> only.<br>An example could be the Out-of-the-box VC Resource Kind ID viz. \"VirtualMachine\"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetMethod</maml:name> <maml:Description> <maml:para>Name of the remediation action that needs to be performed on the resource<br>An example could be a few of the VM lifecycle operations viz. \"shutdown\", \"reset\" 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$RecommendedAction = Initialize-VcfOpsRecommendedAction -ActionAdapterKindId "MyActionAdapterKindId" -TargetAdapterKindId "MyTargetAdapterKindId" -TargetResourceKindId "MyTargetResourceKindId" -TargetMethod "MyTargetMethod" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrecommendedaction with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RecommendedAction = Initialize-VcfOpsRecommendedAction -ActionAdapterKindId "MyActionAdapterKindId" -TargetAdapterKindId "MyTargetAdapterKindId" -TargetMethod "MyTargetMethod" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrecommendedaction with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/RecommendedAction</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsrelationshipconditionrule</command:name> <command:verb>Initialize</command:verb> <command:noun>relationshipconditionrule</command:noun> <maml:description> <maml:para>Model represents relationship rules for a custom group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model represents relationship rules for a custom group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsrelationshipconditionrule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Relation</maml:name> <maml:Description> <maml:para>Relationship Types between resources. All relationships are many-to-many.<br>Representation names are plural.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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 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>CompareOperator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TravesalSpecId</maml:name> <maml:Description> <maml:para>Traversal spec 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Relation</maml:name> <maml:Description> <maml:para>Relationship Types between resources. All relationships are many-to-many.<br>Representation names are plural.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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 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>CompareOperator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TravesalSpecId</maml:name> <maml:Description> <maml:para>Traversal spec 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$RelationshipConditionRule = Initialize-VcfOpsRelationshipConditionRule -Relation "PARENT" -Name "MyName" -CompareOperator "EQ" -TravesalSpecId "MyTravesalSpecId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrelationshipconditionrule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RelationshipConditionRule = Initialize-VcfOpsRelationshipConditionRule -Relation "PARENT" -Name "MyName" -CompareOperator "EQ" -TravesalSpecId "MyTravesalSpecId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrelationshipconditionrule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/RelationshipConditionRule</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsreport</command:name> <command:verb>Initialize</command:verb> <command:noun>report</command:noun> <maml:description> <maml:para>Model representing a Report</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing a Report</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsreport</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of the Report.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Report.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Report.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Resource identifier for which the Report needs to be generated.</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>ReportDefinitionId</maml:name> <maml:Description> <maml:para>Identifier of the Report Definition used to generate this Report.</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>TraversalSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TraversalSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TraversalSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Subject</maml:name> <maml:Description> <maml:para>Subjects of the Report.</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>Owner</maml:name> <maml:Description> <maml:para>Owner (user) who created/executed the Report Generation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompletionTime</maml:name> <maml:Description> <maml:para>Time when the Report Generation completed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Report Generation - whether the Report got generated successfully or not.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></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>Identifier of the Report.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Report.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Report.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Resource identifier for which the Report needs to be generated.</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>ReportDefinitionId</maml:name> <maml:Description> <maml:para>Identifier of the Report Definition used to generate this Report.</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>TraversalSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TraversalSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TraversalSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Subject</maml:name> <maml:Description> <maml:para>Subjects of the Report.</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>Owner</maml:name> <maml:Description> <maml:para>Owner (user) who created/executed the Report Generation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompletionTime</maml:name> <maml:Description> <maml:para>Time when the Report Generation completed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 Report Generation - whether the Report got generated successfully or not.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $Report = Initialize-VcfOpsReport -Id "MyId" -Name "MyName" -Description "MyDescription" -ResourceId "MyResourceId" -ReportDefinitionId "MyReportDefinitionId" -TraversalSpec $TraversalSpec -Subject "MySubject" -Owner "MyOwner" -CompletionTime "MyCompletionTime" -Status "MyStatus" -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsreport with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Report = Initialize-VcfOpsReport -ResourceId "MyResourceId" -ReportDefinitionId "MyReportDefinitionId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsreport with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Report</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstraversalspec</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-VcfOpsreportschedule</command:name> <command:verb>Initialize</command:verb> <command:noun>reportschedule</command:noun> <maml:description> <maml:para>Model to represent a Report Schedule</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model to represent a Report Schedule</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsreportschedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>UUID of the schedule</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>ReportDefinitionId</maml:name> <maml:Description> <maml:para>Report Definition identifier</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>ResourceId</maml:name> <maml:Description> <maml:para>Resource identifiers for which the schedule will be created. Currently we support Schedules for a single Resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>TraversalSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TraversalSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TraversalSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>Starting time when the Report Schedule comes into effect. Defaults to the current 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>WeekOfMonth</maml:name> <maml:Description> <maml:para>Week of the Month</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReportScheduleType</maml:name> <maml:Description> <maml:para>Types of schedule</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DaysOfTheWeek</maml:name> <maml:Description> <maml:para>The days of the week this Schedule repeats - SUNDAY, MONDAY, TUESDAY etc.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ReportSchedule.DaysOfTheWeekEnum></command:parameterValue> <dev:type> <maml:name>List<ReportSchedule.DaysOfTheWeekEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartHour</maml:name> <maml:Description> <maml:para>The hour of the day when the Schedule runs. Defaults to 8.</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>StartMinute</maml:name> <maml:Description> <maml:para>The minutes of the hour when the Schedule runs. Defaults to 0.</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>Recurrence</maml:name> <maml:Description> <maml:para>Indicates the recurrence period of the Schedule. Defaults to 1.</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>DayOfTheMonth</maml:name> <maml:Description> <maml:para>The days of the month when the Schedule will run - Valid values are from 1-31</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>EmailAddresses</maml:name> <maml:Description> <maml:para>Comma separated Email addresses of the recipients for the Report</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>EmailCcAddresses</maml:name> <maml:Description> <maml:para>Comma separated Email addresses of the recipients with Cc for the Report</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>EmailBccAddresses</maml:name> <maml:Description> <maml:para>Comma separated Email addresses of the recipients with Bcc for the Report</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>EmailPluginId</maml:name> <maml:Description> <maml:para>Identifier of the email plugin for which this rule applies.</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>NetworkSharePluginId</maml:name> <maml:Description> <maml:para>Identifier of the network share plugin for which this rule applies.</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>RelativePath</maml:name> <maml:Description> <maml:para>Network file share folder names where the reports should be stored</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>UUID of the schedule</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>ReportDefinitionId</maml:name> <maml:Description> <maml:para>Report Definition identifier</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>ResourceId</maml:name> <maml:Description> <maml:para>Resource identifiers for which the schedule will be created. Currently we support Schedules for a single Resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>TraversalSpec</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TraversalSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TraversalSpec</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>Starting time when the Report Schedule comes into effect. Defaults to the current 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>WeekOfMonth</maml:name> <maml:Description> <maml:para>Week of the Month</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReportScheduleType</maml:name> <maml:Description> <maml:para>Types of schedule</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DaysOfTheWeek</maml:name> <maml:Description> <maml:para>The days of the week this Schedule repeats - SUNDAY, MONDAY, TUESDAY etc.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<ReportSchedule.DaysOfTheWeekEnum></command:parameterValue> <dev:type> <maml:name>List<ReportSchedule.DaysOfTheWeekEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartHour</maml:name> <maml:Description> <maml:para>The hour of the day when the Schedule runs. Defaults to 8.</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>StartMinute</maml:name> <maml:Description> <maml:para>The minutes of the hour when the Schedule runs. Defaults to 0.</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>Recurrence</maml:name> <maml:Description> <maml:para>Indicates the recurrence period of the Schedule. Defaults to 1.</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>DayOfTheMonth</maml:name> <maml:Description> <maml:para>The days of the month when the Schedule will run - Valid values are from 1-31</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>EmailAddresses</maml:name> <maml:Description> <maml:para>Comma separated Email addresses of the recipients for the Report</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>EmailCcAddresses</maml:name> <maml:Description> <maml:para>Comma separated Email addresses of the recipients with Cc for the Report</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>EmailBccAddresses</maml:name> <maml:Description> <maml:para>Comma separated Email addresses of the recipients with Bcc for the Report</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>EmailPluginId</maml:name> <maml:Description> <maml:para>Identifier of the email plugin for which this rule applies.</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>NetworkSharePluginId</maml:name> <maml:Description> <maml:para>Identifier of the network share plugin for which this rule applies.</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>RelativePath</maml:name> <maml:Description> <maml:para>Network file share folder names where the reports should be stored</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> $TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false "UNKNOWN"$ReportSchedule = Initialize-VcfOpsReportSchedule -Id "MyId" -ReportDefinitionId "MyReportDefinitionId" -ResourceId "MyResourceId" -TraversalSpec $TraversalSpec -StartDate "MyStartDate" -WeekOfMonth "UNKNOWNN" -ReportScheduleType "UNKNOWN" -DaysOfTheWeek $TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false "UNKNOWN" -StartHour 0 -StartMinute 0 -Recurrence 0 -DayOfTheMonth 0 -EmailAddresses "MyEmailAddresses" -EmailCcAddresses "MyEmailCcAddresses" -EmailBccAddresses "MyEmailBccAddresses" -EmailPluginId "MyEmailPluginId" -NetworkSharePluginId "MyNetworkSharePluginId" -RelativePath "MyRelativePath" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsreportschedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ReportSchedule = Initialize-VcfOpsReportSchedule -ReportDefinitionId "MyReportDefinitionId" -StartDate "MyStartDate" -Recurrence 0 -DayOfTheMonth 0 -RelativePath "MyRelativePath" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsreportschedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ReportSchedule</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstraversalspec</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-VcfOpsrequestconfig</command:name> <command:verb>Initialize</command:verb> <command:noun>requestconfig</command:noun> <maml:description> <maml:para>Model that represents a webhook template entry.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents a webhook template entry.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsrequestconfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Endpoint</maml:name> <maml:Description> <maml:para>Endpoint in URL 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>Headers</maml:name> <maml:Description> <maml:para>Collection of headers. Header \"Content-type\" should be provided in this list</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.KeyValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.KeyValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Method</maml:name> <maml:Description> <maml:para>Request method</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Payload</maml:name> <maml:Description> <maml:para>Request payload. The following keys can be used for payload construction and should be prefixed by $ : CREATE_TIME, UPDATE_TIME, CANCEL_TIME, ALERT_ID, ALERT_STATUS, ALERT_DEFINITION, ALERT_DEFINITION_DESCRIPTION, ALERT_RECOMMENDATIONS, RESOURCE_NAME, RESOURCE_KIND, RESOURCE_ID, ADAPTER_KIND, RESOURCE_KIND_TYPE, ALERT_IMPACT, CONTROL_STATE, ALERT_CRITICALITY, ALERT_TYPE, ALERT_SUBTYPE, OBJECT_HEALTH_STATE, OBJECT_RISK_STATE, OBJECT_EFFICIENCY_STATE, SYMPTOMS, ADAPTER_INSTANCE, LINK_TO_ALERT</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Endpoint</maml:name> <maml:Description> <maml:para>Endpoint in URL 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>Headers</maml:name> <maml:Description> <maml:para>Collection of headers. Header \"Content-type\" should be provided in this list</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.KeyValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.KeyValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Method</maml:name> <maml:Description> <maml:para>Request method</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Payload</maml:name> <maml:Description> <maml:para>Request payload. The following keys can be used for payload construction and should be prefixed by $ : CREATE_TIME, UPDATE_TIME, CANCEL_TIME, ALERT_ID, ALERT_STATUS, ALERT_DEFINITION, ALERT_DEFINITION_DESCRIPTION, ALERT_RECOMMENDATIONS, RESOURCE_NAME, RESOURCE_KIND, RESOURCE_ID, ADAPTER_KIND, RESOURCE_KIND_TYPE, ALERT_IMPACT, CONTROL_STATE, ALERT_CRITICALITY, ALERT_TYPE, ALERT_SUBTYPE, OBJECT_HEALTH_STATE, OBJECT_RISK_STATE, OBJECT_EFFICIENCY_STATE, SYMPTOMS, ADAPTER_INSTANCE, LINK_TO_ALERT</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $KeyValue = Initialize-VcfOpsKeyValue -Key "MyKey" -Value "MyValue" $RequestConfig = Initialize-VcfOpsRequestConfig -Endpoint "MyEndpoint" -Headers $KeyValue -Method "POST" -Payload "MyPayload" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrequestconfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $RequestConfig = Initialize-VcfOpsRequestConfig -Method "POST" -Payload "MyPayload" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrequestconfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/RequestConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresource</command:name> <command:verb>Initialize</command:verb> <command:noun>resource</command:noun> <maml:description> <maml:para>Represents the external representation of a Resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the external representation of a Resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description 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>CreationTime</maml:name> <maml:Description> <maml:para>Time the Resource was created in the system. This is a 'read-only' property and is system generated.The server ignores any changes to this field when trying to update a resource.</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>ResourceKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialInstanceId</maml:name> <maml:Description> <maml:para>Credential instance identifier assigned to this Resource, applicable only for adapter instances.</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>GeoLocation</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.GeoLocation</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.GeoLocation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceStatusStates</maml:name> <maml:Description> <maml:para>The resource status and resource state for this resource as reported by one or more adapter instances. The server ignores any changes to this field when trying to update a resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceStatusState></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceStatusState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceHealth</maml:name> <maml:Description> <maml:para>Enumeration that identifies the health of a Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceHealthValue</maml:name> <maml:Description> <maml:para>Resource Health Score. This is a 'read-only' property and its value is computed by the system. The server ignores any changes to this field when trying to update a resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DtEnabled</maml:name> <maml:Description> <maml:para>DT calculation enabled or not. By default DT calculation for a resource is enabled (during its 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MonitoringInterval</maml:name> <maml:Description> <maml:para>Minutes part of the monitoring Interval of the resource, applicable only for adapter instances.</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>MonitoringIntervalSeconds</maml:name> <maml:Description> <maml:para>Seconds part of the monitoring Interval of the resource, applicable only for adapter instances.</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>Badges</maml:name> <maml:Description> <maml:para>The various major and minor badges and their values for a Resource. If certain badges are not present in the list then either those badges are not applicable to this resource or the calculation of those badges has been disabled for this resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Badge></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Badge></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RelatedResources</maml:name> <maml:Description> <maml:para>Collection of related resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Extension</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Extension</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Extension</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Identifier</maml:name> <maml:Description> <maml:para>Identifier of the Resource (typically a UUID).</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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description 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>CreationTime</maml:name> <maml:Description> <maml:para>Time the Resource was created in the system. This is a 'read-only' property and is system generated.The server ignores any changes to this field when trying to update a resource.</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>ResourceKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialInstanceId</maml:name> <maml:Description> <maml:para>Credential instance identifier assigned to this Resource, applicable only for adapter instances.</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>GeoLocation</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.GeoLocation</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.GeoLocation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceStatusStates</maml:name> <maml:Description> <maml:para>The resource status and resource state for this resource as reported by one or more adapter instances. The server ignores any changes to this field when trying to update a resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceStatusState></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceStatusState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceHealth</maml:name> <maml:Description> <maml:para>Enumeration that identifies the health of a Resource</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceHealthValue</maml:name> <maml:Description> <maml:para>Resource Health Score. This is a 'read-only' property and its value is computed by the system. The server ignores any changes to this field when trying to update a resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DtEnabled</maml:name> <maml:Description> <maml:para>DT calculation enabled or not. By default DT calculation for a resource is enabled (during its 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MonitoringInterval</maml:name> <maml:Description> <maml:para>Minutes part of the monitoring Interval of the resource, applicable only for adapter instances.</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>MonitoringIntervalSeconds</maml:name> <maml:Description> <maml:para>Seconds part of the monitoring Interval of the resource, applicable only for adapter instances.</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>Badges</maml:name> <maml:Description> <maml:para>The various major and minor badges and their values for a Resource. If certain badges are not present in the list then either those badges are not applicable to this resource or the calculation of those badges has been disabled for this resource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Badge></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Badge></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RelatedResources</maml:name> <maml:Description> <maml:para>Collection of related resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Extension</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Extension</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Extension</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Identifier</maml:name> <maml:Description> <maml:para>Identifier of the Resource (typically a UUID).</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $GeoLocation = Initialize-VcfOpsGeoLocation -Latitude 0 -Longitude 0 $ResourceStatusState = Initialize-VcfOpsResourceStatusState -AdapterInstanceId "MyAdapterInstanceId" -ResourceStatus "NONE" -ResourceState "STOPPED" -StatusMessage "MyStatusMessage" $Badge = Initialize-VcfOpsBadge -Type "ANOMALY" -Color "GREEN" -Score 0 $Resource = Initialize-VcfOpsResource -Description "MyDescription" -CreationTime 0 -ResourceKey $ResourceKey -CredentialInstanceId "MyCredentialInstanceId" -GeoLocation $GeoLocation -ResourceStatusStates $ResourceStatusState -ResourceHealth "GREEN" -ResourceHealthValue 0 -DtEnabled $false -MonitoringInterval 0 -MonitoringIntervalSeconds 0 -Badges $Badge -RelatedResources "MyRelatedResources" -Extension $Extension -Links $Link -Identifier "MyIdentifier" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresource with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" $ResourceStatusState = Initialize-VcfOpsResourceStatusState $Resource = Initialize-VcfOpsResource -CreationTime 0 -ResourceKey $ResourceKey -ResourceStatusStates $ResourceStatusState -ResourceHealth "GREEN" -ResourceHealthValue 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresource with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Resource</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcekey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsgeolocation</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsextension</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-VcfOpsresourceassignment</command:name> <command:verb>Initialize</command:verb> <command:noun>resourceassignment</command:noun> <maml:description> <maml:para>Model representing resource params for policy assignment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing resource params for policy assignment</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourceassignment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Resource Identifier</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>Depth</maml:name> <maml:Description> <maml:para>Resource hierarchy depth</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>ResourceId</maml:name> <maml:Description> <maml:para>Resource Identifier</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>Depth</maml:name> <maml:Description> <maml:para>Resource hierarchy depth</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>$ResourceAssignment = Initialize-VcfOpsResourceAssignment -ResourceId "MyResourceId" -Depth 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceassignment with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceAssignment = Initialize-VcfOpsResourceAssignment -ResourceId "MyResourceId" -Depth 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceassignment with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceAssignment</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcecredential</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcecredential</command:noun> <maml:description> <maml:para>List of resource credentials</maml:para> </maml:description> </command:details> <maml:description> <maml:para>List of resource credentials</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcecredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>The id of the resource</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>Username</maml:name> <maml:Description> <maml:para>The username 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>Password</maml:name> <maml:Description> <maml:para>The password 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>AddRuntimeUser</maml:name> <maml:Description> <maml:para>Flag that indicates whether to add runtime user on resource or no</maml:para> </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>The id of the resource</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>Username</maml:name> <maml:Description> <maml:para>The username 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>Password</maml:name> <maml:Description> <maml:para>The password 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>AddRuntimeUser</maml:name> <maml:Description> <maml:para>Flag that indicates whether to add runtime user on resource or no</maml:para> </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>$ResourceCredential = Initialize-VcfOpsResourceCredential -ResourceId "MyResourceId" -Username "MyUsername" -Password "MyPassword" -AddRuntimeUser $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcecredential with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceCredential = Initialize-VcfOpsResourceCredential -ResourceId "MyResourceId" -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcecredential with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceCredential</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcecredentials</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcecredentials</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-VcfOpsresourcecredentials</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_ResourceCredentials</maml:name> <maml:Description> <maml:para>List of resource credentials</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceCredential></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceCredential></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetainTelegrafConf</maml:name> <maml:Description> <maml:para>Flag that indicates to retain telegraf to preserve configuration, default value is 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>_ResourceCredentials</maml:name> <maml:Description> <maml:para>List of resource credentials</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceCredential></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceCredential></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RetainTelegrafConf</maml:name> <maml:Description> <maml:para>Flag that indicates to retain telegraf to preserve configuration, default value is 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceCredential = Initialize-VcfOpsResourceCredential -ResourceId "MyResourceId" -Username "MyUsername" -Password "MyPassword" -AddRuntimeUser $false $ResourceCredentials = Initialize-VcfOpsResourceCredentials -_ResourceCredentials $ResourceCredential -RetainTelegrafConf $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcecredentials with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceCredential = Initialize-VcfOpsResourceCredential -ResourceId "MyResourceId" -Username "MyUsername" -Password "MyPassword" $ResourceCredentials = Initialize-VcfOpsResourceCredentials -_ResourceCredentials $ResourceCredential </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcecredentials with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/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-VcfOpsResourceFilter</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceFilter</command:noun> <maml:description> <maml:para>Filter for resources. If matchResourceIdOnly is specified, alerts are selected if their resource ids<br>match with the 'resourceId' specified in the filter. Otherwise, the system looks at all the resource's children.<br>The possible set of children can be further filtered based on the <code>childrenResourceKindKeyFilters</code>.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Filter for resources. If matchResourceIdOnly is specified, alerts are selected if their resource ids<br>match with the 'resourceId' specified in the filter. Otherwise, the system looks at all the resource's children.<br>The possible set of children can be further filtered based on the <code>childrenResourceKindKeyFilters</code>.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsResourceFilter</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 that should be matched against the generated alert</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>MatchResourceIdOnly</maml:name> <maml:Description> <maml:para><b>Deprecated, will be removed after couple of releases. Please use relationship instead.</b><br>If set to true, the rule engine does not evaluate the resource's children. Default value is: false.<br><b>NOTE:</b> If set to true, <code>childrenResourceKindKeyFilters</code> has to be empty.</maml:para> </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>ChildrenResourceKindFilters</maml:name> <maml:Description> <maml:para>If matchResourceIdOnly is set to false, this set allows the system to further filter children<br>based on their Resource Kind keys. This filter is deprecated. Please use childrenResourceKindKeyFilters instead.</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>ChildrenResourceKindKeyFilters</maml:name> <maml:Description> <maml:para>Filter based on children resource kind keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKey></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKey></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Relationship</maml:name> <maml:Description> <maml:para>Relationship Types between resources. All relationships are many-to-many.<br>Representation names are plural.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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>Id of the resource that should be matched against the generated alert</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>MatchResourceIdOnly</maml:name> <maml:Description> <maml:para><b>Deprecated, will be removed after couple of releases. Please use relationship instead.</b><br>If set to true, the rule engine does not evaluate the resource's children. Default value is: false.<br><b>NOTE:</b> If set to true, <code>childrenResourceKindKeyFilters</code> has to be empty.</maml:para> </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>ChildrenResourceKindFilters</maml:name> <maml:Description> <maml:para>If matchResourceIdOnly is set to false, this set allows the system to further filter children<br>based on their Resource Kind keys. This filter is deprecated. Please use childrenResourceKindKeyFilters instead.</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>ChildrenResourceKindKeyFilters</maml:name> <maml:Description> <maml:para>Filter based on children resource kind keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKey></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKey></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Relationship</maml:name> <maml:Description> <maml:para>Relationship Types between resources. All relationships are many-to-many.<br>Representation names are plural.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceFilter = Initialize-VcfOpsResourceFilter -ResourceId "MyResourceId" -MatchResourceIdOnly $false -ChildrenResourceKindFilters "MyChildrenResourceKindFilters" -ChildrenResourceKindKeyFilters $ResourceKindKey -Relationship "PARENT" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsResourceFilter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceFilter = Initialize-VcfOpsResourceFilter -ResourceId "MyResourceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsResourceFilter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceFilter</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourceidentifier</command:name> <command:verb>Initialize</command:verb> <command:noun>resourceidentifier</command:noun> <maml:description> <maml:para>A key,value pair that encapsulates the identity of the resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A key,value pair that encapsulates the identity of the resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourceidentifier</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentifierType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceIdentifierType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceIdentifierType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>The resource identifier 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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IdentifierType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceIdentifierType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceIdentifierType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>The resource identifier 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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceidentifier with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceidentifier with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceIdentifier</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourceidentifiertype</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-VcfOpsresourceidentifiertype</command:name> <command:verb>Initialize</command:verb> <command:noun>resourceidentifiertype</command:noun> <maml:description> <maml:para>Meta-data for a Resource Identifier</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Meta-data for a Resource Identifier</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourceidentifiertype</maml:name> <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 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>DataType</maml:name> <maml:Description> <maml:para>Data type for the identifierBy default the data type of the value of a resource identifier is assumed to be a String</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsPartOfUniqueness</maml:name> <maml:Description> <maml:para>True if this ResourceIdentifier is used to uniquely identify the Resource in the system. By default the resource identifier is considered to be part of uniqueness</maml:para> </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>Extension</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Extension</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Extension</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 name of the 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>DataType</maml:name> <maml:Description> <maml:para>Data type for the identifierBy default the data type of the value of a resource identifier is assumed to be a String</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsPartOfUniqueness</maml:name> <maml:Description> <maml:para>True if this ResourceIdentifier is used to uniquely identify the Resource in the system. By default the resource identifier is considered to be part of uniqueness</maml:para> </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>Extension</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Extension</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Extension</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceidentifiertype with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceidentifiertype with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceIdentifierType</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsextension</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-VcfOpsresourcekey</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcekey</command:noun> <maml:description> <maml:para>Represents a composite key for uniquely identifying a Resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a composite key for uniquely identifying a Resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcekey</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 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>AdapterKindKey</maml:name> <maml:Description> <maml:para>Adapter Kind to which the resource belongs 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>Resource Kind to which the resource belongs 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>A collection of Resource Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceIdentifier></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceIdentifier></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Extension</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Extension</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Extension</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 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>AdapterKindKey</maml:name> <maml:Description> <maml:para>Adapter Kind to which the resource belongs 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>Resource Kind to which the resource belongs 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>A collection of Resource Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceIdentifier></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceIdentifier></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Extension</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.Extension</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.Extension</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcekey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcekey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceKey</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsextension</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-VcfOpsResourceKindFilter</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceKindFilter</command:noun> <maml:description> <maml:para>Filter based on the resource kind</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Filter based on the resource kind</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsResourceKindFilter</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>Resource kind of a 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>AdapterKind</maml:name> <maml:Description> <maml:para>Adapter kind of a 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>Resource kind of a 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>AdapterKind</maml:name> <maml:Description> <maml:para>Adapter kind of a 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceKindFilter = Initialize-VcfOpsResourceKindFilter -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsResourceKindFilter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKindFilter = Initialize-VcfOpsResourceKindFilter </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsResourceKindFilter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceKindFilter</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcekindkey</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcekindkey</command:noun> <maml:description> <maml:para>Resource type details.(adapter kind, resource kinds)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resource type details.(adapter kind, resource kinds)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcekindkey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind 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>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>The resource kind 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>AdapterKind</maml:name> <maml:Description> <maml:para>The adapter kind 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcekindkey with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcekindkey with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceKindKey</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcekindkeystats</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcekindkeystats</command:noun> <maml:description> <maml:para>Represents resource kind key and stats values selected for it</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents resource kind key and stats values selected for it</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcekindkeystats</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKindKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKindKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Stats</maml:name> <maml:Description> <maml:para>Stats selected for resource kind 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKindKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKindKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Stats</maml:name> <maml:Description> <maml:para>Stats selected for resource kind 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKeyStats = Initialize-VcfOpsResourceKindKeyStats -ResourceKindKey $ResourceKindKey -Stats "MyStats" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcekindkeystats with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceKindKeyStats = Initialize-VcfOpsResourceKindKeyStats </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcekindkeystats with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceKindKeyStats</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcekindkey</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-VcfOpsresourcekindsettings</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcekindsettings</command:noun> <maml:description> <maml:para>Resource kind key settings for policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resource kind key settings for policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcekindsettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$ResourceKindSettings = Initialize-VcfOpsResourceKindSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcekindsettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceKindSettings = Initialize-VcfOpsResourceKindSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcekindsettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceKindSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcenameconditionrule</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcenameconditionrule</command:noun> <maml:description> <maml:para>Model represents resource name rules for a custom group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model represents resource name rules for a custom group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcenameconditionrule</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 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>CompareOperator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.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 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>CompareOperator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceNameConditionRule = Initialize-VcfOpsResourceNameConditionRule -Name "MyName" -CompareOperator "EQ" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcenameconditionrule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceNameConditionRule = Initialize-VcfOpsResourceNameConditionRule -Name "MyName" -CompareOperator "EQ" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcenameconditionrule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceNameConditionRule</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourceparameters</command:name> <command:verb>Initialize</command:verb> <command:noun>resourceparameters</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-VcfOpsresourceparameters</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ContextResourceIDs</maml:name> <maml:Description> <maml:para>Collection of resource IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ContextResourceIDs</maml:name> <maml:Description> <maml:para>Collection of resource IDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceParameters = Initialize-VcfOpsResourceParameters -ContextResourceIDs "MyContextResourceIDs" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceparameters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceParameters = Initialize-VcfOpsResourceParameters -ContextResourceIDs "MyContextResourceIDs" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceparameters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceParameters</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcepropertycontents</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcepropertycontents</command:noun> <maml:description> <maml:para>Represents the Property Contents for a given resource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the Property Contents for a given resource</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcepropertycontents</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>The resource 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>PropertyContents</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>The resource 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>PropertyContents</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PropertyContents</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PropertyContents</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent $ResourcePropertyContents = Initialize-VcfOpsResourcePropertyContents -ResourceId "MyResourceId" -PropertyContents $PropertyContents </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcepropertycontents with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent $ResourcePropertyContents = Initialize-VcfOpsResourcePropertyContents -ResourceId "MyResourceId" -PropertyContents $PropertyContents </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcepropertycontents with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourcePropertyContents</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspropertycontents</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-VcfOpsresourcequery</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcequery</command:noun> <maml:description> <maml:para>Object used to lookup resources with various filtering criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Object used to lookup resources with various filtering criteria</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcequery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Array of resource names to query for.<br><b>NOTE:</b> Currently, only single element supported</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>Regex</maml:name> <maml:Description> <maml:para>Array of resource names in java regex format.<br><b>NOTE:</b> <i>regex</i> and <i>name</i> are mutually exclusive. If both are specified, <i>name</i> is given preference.</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>AdapterKind</maml:name> <maml:Description> <maml:para>Array of Adapter Kind keys</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>ResourceKind</maml:name> <maml:Description> <maml:para>Array of Resource Kind keys</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>CollectorName</maml:name> <maml:Description> <maml:para>Array of Collector 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>MaintenanceScheduleId</maml:name> <maml:Description> <maml:para>Array of {@link UUID} that identify Maintenance Schedules.<br>Since vROps 6.1.0 release onwards, we don't support search<br>and look up of Resources using Maintenance Schedules' identifiers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterInstanceId</maml:name> <maml:Description> <maml:para>Array of uuids that identify adapter instances</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RecentlyAdded</maml:name> <maml:Description> <maml:para>Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.</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>ResourceState</maml:name> <maml:Description> <maml:para>Array of resource states. <b>NOTE</b>, the following states are applicable only for adapter instances: STOPPED, STARTING, STOPPING, UPDATING, FAILED, REMOVING</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceState></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceStatus</maml:name> <maml:Description> <maml:para>Array of resource data collection statuses. <b>NOTE</b>, the following statuses are applicable only for adapter instances: ERROR, DOWN, COLLECTOR_DOWN. The statuses OLD_DATA_RECEIVING, NO_PARENT_MONITORING and UNKNOWN are deprecated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceDataCollectionStatus></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceDataCollectionStatus></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceHealth</maml:name> <maml:Description> <maml:para>Array of resource health</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceHealth></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceHealth></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParentId</maml:name> <maml:Description> <maml:para>Array of UUID of object that are the parent resource in a parent child relationship</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>CredentialId</maml:name> <maml:Description> <maml:para>Array of CredentialIDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>PropertyName</maml:name> <maml:Description> <maml:para>Name of property. Query only supports filtering for a single property.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyValue</maml:name> <maml:Description> <maml:para>Value of property. Omitting the property value will check for existence<br>of the property name on the resource.<br><b>NOTE:</b> Use 'propertyConditions' to specify lookup of Resource using multiple properties.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKey</maml:name> <maml:Description> <maml:para>Name of resource StatKey to validate value is within a range.<br>Use with statKeyLowerBound, statKeyUpperBound and statKeyInclusive to create comparison conditions<br><b>NOTE:</b> Use 'statConditions' to specify lookup of Resource using multiple stat keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyLowerBound</maml:name> <maml:Description> <maml:para>StatKey value matching range lower bound</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyUpperBound</maml:name> <maml:Description> <maml:para>StatKey value matching range upper bound</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyInclusive</maml:name> <maml:Description> <maml:para>Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyConditions</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatOrPropertyConditionQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatOrPropertyConditionQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatConditions</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatOrPropertyConditionQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatOrPropertyConditionQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeRelated</maml:name> <maml:Description> <maml:para>Relationship Types between resources. All relationships are many-to-many.<br>Representation names are plural.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceTag</maml:name> <maml:Description> <maml:para>Property used for tag filtering.<br><b>NOTE:</b> If specified, only the resources with the tags will be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceTag></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceTag></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>Array of resource names to query for.<br><b>NOTE:</b> Currently, only single element supported</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>Regex</maml:name> <maml:Description> <maml:para>Array of resource names in java regex format.<br><b>NOTE:</b> <i>regex</i> and <i>name</i> are mutually exclusive. If both are specified, <i>name</i> is given preference.</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>AdapterKind</maml:name> <maml:Description> <maml:para>Array of Adapter Kind keys</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>ResourceKind</maml:name> <maml:Description> <maml:para>Array of Resource Kind keys</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>CollectorName</maml:name> <maml:Description> <maml:para>Array of Collector 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>MaintenanceScheduleId</maml:name> <maml:Description> <maml:para>Array of {@link UUID} that identify Maintenance Schedules.<br>Since vROps 6.1.0 release onwards, we don't support search<br>and look up of Resources using Maintenance Schedules' identifiers.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>AdapterInstanceId</maml:name> <maml:Description> <maml:para>Array of uuids that identify adapter instances</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RecentlyAdded</maml:name> <maml:Description> <maml:para>Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.</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>ResourceState</maml:name> <maml:Description> <maml:para>Array of resource states. <b>NOTE</b>, the following states are applicable only for adapter instances: STOPPED, STARTING, STOPPING, UPDATING, FAILED, REMOVING</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceState></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceState></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceStatus</maml:name> <maml:Description> <maml:para>Array of resource data collection statuses. <b>NOTE</b>, the following statuses are applicable only for adapter instances: ERROR, DOWN, COLLECTOR_DOWN. The statuses OLD_DATA_RECEIVING, NO_PARENT_MONITORING and UNKNOWN are deprecated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceDataCollectionStatus></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceDataCollectionStatus></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceHealth</maml:name> <maml:Description> <maml:para>Array of resource health</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceHealth></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceHealth></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ParentId</maml:name> <maml:Description> <maml:para>Array of UUID of object that are the parent resource in a parent child relationship</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>CredentialId</maml:name> <maml:Description> <maml:para>Array of CredentialIDs</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource Identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>PropertyName</maml:name> <maml:Description> <maml:para>Name of property. Query only supports filtering for a single property.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyValue</maml:name> <maml:Description> <maml:para>Value of property. Omitting the property value will check for existence<br>of the property name on the resource.<br><b>NOTE:</b> Use 'propertyConditions' to specify lookup of Resource using multiple properties.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKey</maml:name> <maml:Description> <maml:para>Name of resource StatKey to validate value is within a range.<br>Use with statKeyLowerBound, statKeyUpperBound and statKeyInclusive to create comparison conditions<br><b>NOTE:</b> Use 'statConditions' to specify lookup of Resource using multiple stat keys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyLowerBound</maml:name> <maml:Description> <maml:para>StatKey value matching range lower bound</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyUpperBound</maml:name> <maml:Description> <maml:para>StatKey value matching range upper bound</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKeyInclusive</maml:name> <maml:Description> <maml:para>Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PropertyConditions</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatOrPropertyConditionQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatOrPropertyConditionQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatConditions</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.StatOrPropertyConditionQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.StatOrPropertyConditionQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeRelated</maml:name> <maml:Description> <maml:para>Relationship Types between resources. All relationships are many-to-many.<br>Representation names are plural.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceTag</maml:name> <maml:Description> <maml:para>Property used for tag filtering.<br><b>NOTE:</b> If specified, only the resources with the tags will be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceTag></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceTag></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcequery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceQuery = Initialize-VcfOpsResourceQuery </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcequery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceQuery</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsstatorpropertyconditionquery</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsstatorpropertyconditionquery</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-VcfOpsresourcerelationshipsquery</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcerelationshipsquery</command:noun> <maml:description> <maml:para>Object used to lookup resources satisfying various filtering criteria and related to given set of resources<br>with given relation type.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Object used to lookup resources satisfying various filtering criteria and related to given set of resources<br>with given relation type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcerelationshipsquery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RelationshipType</maml:name> <maml:Description> <maml:para>Relationship Types between resources. All relationships are many-to-many.<br>Representation names are plural.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Resource uuids to get the related resources for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceQuery</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HierarchyDepth</maml:name> <maml:Description> <maml:para>Relation hierarchy depth. Used with relationship types DESCENDANT, ANCESTOR and ALL. Defaults to 10.</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>RelationshipType</maml:name> <maml:Description> <maml:para>Relationship Types between resources. All relationships are many-to-many.<br>Representation names are plural.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceIds</maml:name> <maml:Description> <maml:para>Resource uuids to get the related resources for</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceQuery</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>HierarchyDepth</maml:name> <maml:Description> <maml:para>Relation hierarchy depth. Used with relationship types DESCENDANT, ANCESTOR and ALL. Defaults to 10.</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> $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag $ResourceRelationshipsQuery = Initialize-VcfOpsResourceRelationshipsQuery -RelationshipType "PARENT" -ResourceIds "MyResourceIds" -ResourceQuery $ResourceQuery -HierarchyDepth 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcerelationshipsquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceRelationshipsQuery = Initialize-VcfOpsResourceRelationshipsQuery -RelationshipType "PARENT" -ResourceIds "MyResourceIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcerelationshipsquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceRelationshipsQuery</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcequery</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-VcfOpsResourceSelection</command:name> <command:verb>Initialize</command:verb> <command:noun>ResourceSelection</command:noun> <maml:description> <maml:para>A selection type and set of resource ids.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A selection type and set of resource ids.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsResourceSelection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Enumerated type for how resources can be selected</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>Set of resource uuids</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Type</maml:name> <maml:Description> <maml:para>Enumerated type for how resources can be selected</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>Set of resource uuids</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsResourceSelection with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsResourceSelection with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceSelection</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcestatcontent</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcestatcontent</command:noun> <maml:description> <maml:para>Represents a Resource and Stats associated with the Resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a Resource and Stats associated with the Resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcestatcontent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of the Resource (typically a UUID).</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>ResourceKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatContents</maml:name> <maml:Description> <maml:para>The stats (numeric or string) data for one or more StatKeys. The stats (numeric or string) data for one or more StatKeys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.StatContent></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.StatContent></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>Identifier of the Resource (typically a UUID).</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>ResourceKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKey</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatContents</maml:name> <maml:Description> <maml:para>The stats (numeric or string) data for one or more StatKeys. The stats (numeric or string) data for one or more StatKeys.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.StatContent></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.StatContent></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $ResourceStatContent = Initialize-VcfOpsResourceStatContent -Id "MyId" -ResourceKey $ResourceKey -StatContents $StatContent </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcestatcontent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceStatContent = Initialize-VcfOpsResourceStatContent -Id "MyId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcestatcontent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceStatContent</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcekey</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-VcfOpsresourcestatusstate</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcestatusstate</command:noun> <maml:description> <maml:para>Contains the Adapter Instance ResourceDataCollectionStatus and ResourceState for a Resource. A Resource will have a ResourceStatusState instance for each Adapter Instance that collects information about the resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains the Adapter Instance ResourceDataCollectionStatus and ResourceState for a Resource. A Resource will have a ResourceStatusState instance for each Adapter Instance that collects information about the resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcestatusstate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterInstanceId</maml:name> <maml:Description> <maml:para>The Adapter Instance identifier associated with the status and state</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>ResourceStatus</maml:name> <maml:Description> <maml:para>Enumeration of resource data collection status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceState</maml:name> <maml:Description> <maml:para>Resource State enumerates the collection state for a particular resource.<br>It does not represent the data collection status which is enumerated by ResourceDataCollectionStatus</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatusMessage</maml:name> <maml:Description> <maml:para>A human readable status 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterInstanceId</maml:name> <maml:Description> <maml:para>The Adapter Instance identifier associated with the status and state</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>ResourceStatus</maml:name> <maml:Description> <maml:para>Enumeration of resource data collection status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceState</maml:name> <maml:Description> <maml:para>Resource State enumerates the collection state for a particular resource.<br>It does not represent the data collection status which is enumerated by ResourceDataCollectionStatus</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatusMessage</maml:name> <maml:Description> <maml:para>A human readable status 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>$ResourceStatusState = Initialize-VcfOpsResourceStatusState -AdapterInstanceId "MyAdapterInstanceId" -ResourceStatus "NONE" -ResourceState "STOPPED" -StatusMessage "MyStatusMessage" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcestatusstate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceStatusState = Initialize-VcfOpsResourceStatusState </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcestatusstate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceStatusState</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourceTag</command:name> <command:verb>Initialize</command:verb> <command:noun>resourceTag</command:noun> <maml:description> <maml:para>Object used to define filtering criteria based on the pair of category and tag</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Object used to define filtering criteria based on the pair of category and tag</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourceTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Category</maml:name> <maml:Description> <maml:para>The localized name of the category</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>The localized name of the tag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Category</maml:name> <maml:Description> <maml:para>The localized name of the category</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>The localized name of the tag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceTag with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourceTag with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceTag</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcetagconditionrule</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcetagconditionrule</command:noun> <maml:description> <maml:para>Model represents resource tag rules for a custom group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model represents resource tag rules for a custom group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcetagconditionrule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Category</maml:name> <maml:Description> <maml:para>Category of the resource tag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompareOperator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StringValue</maml:name> <maml:Description> <maml:para>String value of the tag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Category</maml:name> <maml:Description> <maml:para>Category of the resource tag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompareOperator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StringValue</maml:name> <maml:Description> <maml:para>String value of the tag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$ResourceTagConditionRule = Initialize-VcfOpsResourceTagConditionRule -Category "MyCategory" -CompareOperator "EQ" -StringValue "MyStringValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcetagconditionrule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ResourceTagConditionRule = Initialize-VcfOpsResourceTagConditionRule -Category "MyCategory" -CompareOperator "EQ" -StringValue "MyStringValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcetagconditionrule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourceTagConditionRule</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcespropertycontents</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcespropertycontents</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-VcfOpsresourcespropertycontents</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Values</maml:name> <maml:Description> <maml:para>Collection of resource property contents</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourcePropertyContents></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourcePropertyContents></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>Values</maml:name> <maml:Description> <maml:para>Collection of resource property contents</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourcePropertyContents></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourcePropertyContents></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PropertyContent = Initialize-VcfOpsPropertyContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $PropertyContents = Initialize-VcfOpsPropertyContents -PropertyContent $PropertyContent $ResourcePropertyContents = Initialize-VcfOpsResourcePropertyContents -ResourceId "MyResourceId" -PropertyContents $PropertyContents $ResourcesPropertyContents = Initialize-VcfOpsResourcesPropertyContents -Values $ResourcePropertyContents </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcespropertycontents with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourcesPropertyContents = Initialize-VcfOpsResourcesPropertyContents </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcespropertycontents with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourcesPropertyContents</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsresourcesstatcontents</command:name> <command:verb>Initialize</command:verb> <command:noun>resourcesstatcontents</command:noun> <maml:description> <maml:para>Represents a Collection of Resources and Stats associated with each Resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a Collection of Resources and Stats associated with each Resource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsresourcesstatcontents</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceStatContent</maml:name> <maml:Description> <maml:para>Collection of Resources and the associated Stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceStatContent></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceStatContent></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>ResourceStatContent</maml:name> <maml:Description> <maml:para>Collection of Resources and the associated Stats</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceStatContent></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceStatContent></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Extension = Initialize-VcfOpsExtension -AnyObjects 0 $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $ResourceIdentifierType = Initialize-VcfOpsResourceIdentifierType -Name "MyName" -DataType "STRING" -IsPartOfUniqueness $false -Extension $Extension -Links $Link $ResourceIdentifier = Initialize-VcfOpsResourceIdentifier -IdentifierType $ResourceIdentifierType -Value "MyValue" -Links $Link $ResourceKey = Initialize-VcfOpsResourceKey -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -ResourceIdentifiers $ResourceIdentifier -Links $Link -Extension $Extension $StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $ResourceStatContent = Initialize-VcfOpsResourceStatContent -Id "MyId" -ResourceKey $ResourceKey -StatContents $StatContent $ResourcesStatContents = Initialize-VcfOpsResourcesStatContents -ResourceStatContent $ResourceStatContent </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcesstatcontents with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourcesStatContents = Initialize-VcfOpsResourcesStatContents </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsresourcesstatcontents with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ResourcesStatContents</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsrolepermission</command:name> <command:verb>Initialize</command:verb> <command:noun>rolepermission</command:noun> <maml:description> <maml:para>Represents role based permissions to objects. The role's privileges will apply to all of the objects identified by the traversal specification. Optionally permission can be flagged to allow all objects ignoring traversal specifications.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents role based permissions to objects. The role's privileges will apply to all of the objects identified by the traversal specification. Optionally permission can be flagged to allow all objects ignoring traversal specifications.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsrolepermission</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The role 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>ScopeId</maml:name> <maml:Description> <maml:para>The id of the scope</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>TraversalSpecInstances</maml:name> <maml:Description> <maml:para>Collection of traversal specification instances</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AllowAllObjects</maml:name> <maml:Description> <maml:para>If true then ignore traversal specifications and allow all objects</maml:para> </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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RoleName</maml:name> <maml:Description> <maml:para>The role 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>ScopeId</maml:name> <maml:Description> <maml:para>The id of the scope</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>TraversalSpecInstances</maml:name> <maml:Description> <maml:para>Collection of traversal specification instances</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AllowAllObjects</maml:name> <maml:Description> <maml:para>If true then ignore traversal specifications and allow all objects</maml:para> </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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrolepermission with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsrolepermission with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/RolePermission</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsschedule</command:name> <command:verb>Initialize</command:verb> <command:noun>schedule</command:noun> <maml:description> <maml:para>Schedule represents the meta information required by the server to set resources in maintenance mode at the right interval/time. To construct specific schedules, please see some of the static helper utilities in this class.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Schedule represents the meta information required by the server to set resources in maintenance mode at the right interval/time. To construct specific schedules, please see some of the static helper utilities in this class.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsschedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Hour</maml:name> <maml:Description> <maml:para>The beginning hour of the schedule.</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>MinuteOfTheHour</maml:name> <maml:Description> <maml:para>The beginning minutes of the schedule.</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>Duration</maml:name> <maml:Description> <maml:para>Duration of the schedule in minutes.</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>ScheduleType</maml:name> <maml:Description> <maml:para>Schedule type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Recurrence</maml:name> <maml:Description> <maml:para>Configures how the schedule is repeated within the provided interval, e.g. if <code>scheduleType = DAILY</code> then setting <code>recurrence = 2</code> would trigger the job every 2 days.<br/>Applicable only when <code>scheduleType = DAILY</code> or <code>scheduleType = WEEKLY</code>.</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>DayOfTheMonth</maml:name> <maml:Description> <maml:para><b>Deprecated, will be removed after couple of releases.</b><br/>Day of the month on which the job should be triggered. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with daysOfTheMonth and weeksOfTheMonth.</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>DaysOfTheMonth</maml:name> <maml:Description> <maml:para>The list of the days of the month on which the job should be triggered. Applicable values are {1,2,...,31,LAST}. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with dayOfTheMonth and weeksOfTheMonth.</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>WeeksOfTheMonth</maml:name> <maml:Description> <maml:para>The list of the week indices of the month on which the job should be triggered. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with dayOfTheMonth and daysOfTheMonth, should be specified together with daysOfTheWeek.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Schedule.WeeksOfTheMonthEnum></command:parameterValue> <dev:type> <maml:name>List<Schedule.WeeksOfTheMonthEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DaysOfTheWeek</maml:name> <maml:Description> <maml:para>Days of the week on which the job should be triggered. Must be specified only when <code>scheduleType = WEEKLY</code> or <code>scheduleType = MONTHLY</code>.<br/>When <code>scheduleType = MONTHLY</code> this parameter is mutually exclusive with dayOfTheMonth and daysOfTheMonth, should be specified together with daysOfTheWeek.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Schedule.DaysOfTheWeekEnum></command:parameterValue> <dev:type> <maml:name>List<Schedule.DaysOfTheWeekEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Month</maml:name> <maml:Description> <maml:para><b>Deprecated, will be removed after couple of releases.</b><br/>Month of the year on which the job should be triggered. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with months.</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>Months</maml:name> <maml:Description> <maml:para>Months of the year on which the job should be triggered. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with month.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>StartDate</maml:name> <maml:Description> <maml:para>Start date for the schedule. Should be in format MM/DD/YYYY and if not specified current date 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExpirationDate</maml:name> <maml:Description> <maml:para>The expiration date of the schedule. Should be in format MM/DD/YYYY. Mutually exclusive with expireRuns and either of them should be always defined when <code>scheduleType != ONCE</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>TimeZone</maml:name> <maml:Description> <maml:para>Time Zone of the schedule.<br/>If not provided, defaults to the time of the VMware Cloud Foundation Operations 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>ExpireRuns</maml:name> <maml:Description> <maml:para>The number of run after which the schedule should expire. Mutually exclusive with expirationDate and either of them should be always defined when <code>scheduleType != ONCE</code>.</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>Hour</maml:name> <maml:Description> <maml:para>The beginning hour of the schedule.</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>MinuteOfTheHour</maml:name> <maml:Description> <maml:para>The beginning minutes of the schedule.</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>Duration</maml:name> <maml:Description> <maml:para>Duration of the schedule in minutes.</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>ScheduleType</maml:name> <maml:Description> <maml:para>Schedule type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Recurrence</maml:name> <maml:Description> <maml:para>Configures how the schedule is repeated within the provided interval, e.g. if <code>scheduleType = DAILY</code> then setting <code>recurrence = 2</code> would trigger the job every 2 days.<br/>Applicable only when <code>scheduleType = DAILY</code> or <code>scheduleType = WEEKLY</code>.</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>DayOfTheMonth</maml:name> <maml:Description> <maml:para><b>Deprecated, will be removed after couple of releases.</b><br/>Day of the month on which the job should be triggered. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with daysOfTheMonth and weeksOfTheMonth.</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>DaysOfTheMonth</maml:name> <maml:Description> <maml:para>The list of the days of the month on which the job should be triggered. Applicable values are {1,2,...,31,LAST}. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with dayOfTheMonth and weeksOfTheMonth.</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>WeeksOfTheMonth</maml:name> <maml:Description> <maml:para>The list of the week indices of the month on which the job should be triggered. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with dayOfTheMonth and daysOfTheMonth, should be specified together with daysOfTheWeek.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Schedule.WeeksOfTheMonthEnum></command:parameterValue> <dev:type> <maml:name>List<Schedule.WeeksOfTheMonthEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DaysOfTheWeek</maml:name> <maml:Description> <maml:para>Days of the week on which the job should be triggered. Must be specified only when <code>scheduleType = WEEKLY</code> or <code>scheduleType = MONTHLY</code>.<br/>When <code>scheduleType = MONTHLY</code> this parameter is mutually exclusive with dayOfTheMonth and daysOfTheMonth, should be specified together with daysOfTheWeek.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Schedule.DaysOfTheWeekEnum></command:parameterValue> <dev:type> <maml:name>List<Schedule.DaysOfTheWeekEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Month</maml:name> <maml:Description> <maml:para><b>Deprecated, will be removed after couple of releases.</b><br/>Month of the year on which the job should be triggered. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with months.</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>Months</maml:name> <maml:Description> <maml:para>Months of the year on which the job should be triggered. Must be specified only when <code>scheduleType = MONTHLY</code>. Mutually exclusive with month.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>StartDate</maml:name> <maml:Description> <maml:para>Start date for the schedule. Should be in format MM/DD/YYYY and if not specified current date 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExpirationDate</maml:name> <maml:Description> <maml:para>The expiration date of the schedule. Should be in format MM/DD/YYYY. Mutually exclusive with expireRuns and either of them should be always defined when <code>scheduleType != ONCE</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>TimeZone</maml:name> <maml:Description> <maml:para>Time Zone of the schedule.<br/>If not provided, defaults to the time of the VMware Cloud Foundation Operations 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>ExpireRuns</maml:name> <maml:Description> <maml:para>The number of run after which the schedule should expire. Mutually exclusive with expirationDate and either of them should be always defined when <code>scheduleType != ONCE</code>.</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>"UNKNOWNN""UNKNOWN"$Schedule = Initialize-VcfOpsSchedule -Hour 0 -MinuteOfTheHour 0 -Duration 0 -ScheduleType "UNKNOWN" -Recurrence 0 -DayOfTheMonth 0 -DaysOfTheMonth "MyDaysOfTheMonth" -WeeksOfTheMonth "UNKNOWNN" -DaysOfTheWeek "UNKNOWNN""UNKNOWN" -Month 0 -Months 0 -StartDate "MyStartDate" -ExpirationDate "MyExpirationDate" -TimeZone "MyTimeZone" -ExpireRuns 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsschedule with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Schedule = Initialize-VcfOpsSchedule -Hour 0 -MinuteOfTheHour 0 -Duration 0 -ScheduleType "UNKNOWN" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsschedule with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Schedule</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsscope</command:name> <command:verb>Initialize</command:verb> <command:noun>scope</command:noun> <maml:description> <maml:para>Represents a VMware Cloud Foundation Operations Manager system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a VMware Cloud Foundation Operations Manager system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsscope</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of the Scope in the system.</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>Name</maml:name> <maml:Description> <maml:para>Name of the scope.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 scope.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TraversalSpecInstances</maml:name> <maml:Description> <maml:para>List of traversal spec instances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance></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>Identifier of the Scope in the system.</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>Name</maml:name> <maml:Description> <maml:para>Name of the scope.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 scope.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TraversalSpecInstances</maml:name> <maml:Description> <maml:para>List of traversal spec instances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TraversalSpecInstance></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Scope = Initialize-VcfOpsScope -Id "MyId" -Name "MyName" -Description "MyDescription" -TraversalSpecInstances $TraversalSpecInstance </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsscope with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $Scope = Initialize-VcfOpsScope -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsscope with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Scope</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsSdmpConfig</command:name> <command:verb>Initialize</command:verb> <command:noun>SdmpConfig</command:noun> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating or updating vCenter Service Discovery adapter instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating or updating vCenter Service Discovery adapter instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsSdmpConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultWindowsCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CredentialParams</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CredentialParams</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultLinuxCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CredentialParams</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CredentialParams</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultSRMCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CredentialParams</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CredentialParams</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicationDiscoveryEnabled</maml:name> <maml:Description> <maml:para>Enable application discovery flag, enabled by default.</maml:para> </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>Enabled</maml:name> <maml:Description> <maml:para>Enable service discovery flag, disabled by default.</maml:para> </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>Id</maml:name> <maml:Description> <maml:para>Identifier of this Service Discovery adapter, automatically assigned by the system on create. Must be set in case of update.</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>AlternateCredentialsId</maml:name> <maml:Description> <maml:para>Alternate credentials if for Service Discovery adapter. If not set will reuse vCenter credentials instead</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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultWindowsCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CredentialParams</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CredentialParams</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultLinuxCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CredentialParams</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CredentialParams</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DefaultSRMCredentials</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.CredentialParams</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.CredentialParams</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ApplicationDiscoveryEnabled</maml:name> <maml:Description> <maml:para>Enable application discovery flag, enabled by default.</maml:para> </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>Enabled</maml:name> <maml:Description> <maml:para>Enable service discovery flag, disabled by default.</maml:para> </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>Id</maml:name> <maml:Description> <maml:para>Identifier of this Service Discovery adapter, automatically assigned by the system on create. Must be set in case of update.</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>AlternateCredentialsId</maml:name> <maml:Description> <maml:para>Alternate credentials if for Service Discovery adapter. If not set will reuse vCenter credentials instead</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $CredentialParams = Initialize-VcfOpsCredentialParams -Username "MyUsername" -Password "MyPassword" $SdmpConfig = Initialize-VcfOpsSdmpConfig -DefaultWindowsCredentials $CredentialParams -DefaultLinuxCredentials $CredentialParams -DefaultSRMCredentials $CredentialParams -ApplicationDiscoveryEnabled $false -Enabled $false -Id "MyId" -AlternateCredentialsId "MyAlternateCredentialsId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsSdmpConfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SdmpConfig = Initialize-VcfOpsSdmpConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsSdmpConfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/SdmpConfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscredentialparams</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscredentialparams</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpscredentialparams</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-VcfOpsSearchCriteria</command:name> <command:verb>Initialize</command:verb> <command:noun>SearchCriteria</command:noun> <maml:description> <maml:para>The key value pair for storing search criteria</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The key value pair for storing search criteria</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsSearchCriteria</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>Field for search and sort on bills summary</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>Search Criteria 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="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>Field for search and sort on bills summary</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>Search Criteria 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>$SearchCriteria = Initialize-VcfOpsSearchCriteria -Key "RESOURCE_NAME" -Value "MyValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsSearchCriteria with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SearchCriteria = Initialize-VcfOpsSearchCriteria -Key "RESOURCE_NAME" -Value "MyValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsSearchCriteria with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/SearchCriteria</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsserviceconfiguration</command:name> <command:verb>Initialize</command:verb> <command:noun>serviceconfiguration</command:noun> <maml:description> <maml:para>Service Configuration Description</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Service Configuration Description</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsserviceconfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigName</maml:name> <maml:Description> <maml:para>The name of the configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsActivated</maml:name> <maml:Description> <maml:para>Flag that indicates whether to activate configuration or no</maml:para> </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>Parameters</maml:name> <maml:Description> <maml:para>Collection of service configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.KeyValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.KeyValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigName</maml:name> <maml:Description> <maml:para>The name of the configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsActivated</maml:name> <maml:Description> <maml:para>Flag that indicates whether to activate configuration or no</maml:para> </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>Parameters</maml:name> <maml:Description> <maml:para>Collection of service configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.KeyValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.KeyValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $KeyValue = Initialize-VcfOpsKeyValue -Key "MyKey" -Value "MyValue" $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -IsActivated $false -Parameters $KeyValue </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsserviceconfiguration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $KeyValue = Initialize-VcfOpsKeyValue $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -Parameters $KeyValue </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsserviceconfiguration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ServiceConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsserviceconfigurationdeleteparameter</command:name> <command:verb>Initialize</command:verb> <command:noun>serviceconfigurationdeleteparameter</command:noun> <maml:description> <maml:para>Collection of applications service configurations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Collection of applications service configurations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsserviceconfigurationdeleteparameter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServiceName</maml:name> <maml:Description> <maml:para>The name of the application service</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigNames</maml:name> <maml:Description> <maml:para>Collection of configurations to be deleted</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>ServiceName</maml:name> <maml:Description> <maml:para>The name of the application service</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConfigNames</maml:name> <maml:Description> <maml:para>Collection of configurations to be deleted</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>$ServiceConfigurationDeleteParameter = Initialize-VcfOpsServiceConfigurationDeleteParameter -ServiceName "MyServiceName" -ConfigNames "MyConfigNames" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsserviceconfigurationdeleteparameter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$ServiceConfigurationDeleteParameter = Initialize-VcfOpsServiceConfigurationDeleteParameter -ServiceName "MyServiceName" -ConfigNames "MyConfigNames" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsserviceconfigurationdeleteparameter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ServiceConfigurationDeleteParameter</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsserviceconfigurationdeleteparameters</command:name> <command:verb>Initialize</command:verb> <command:noun>serviceconfigurationdeleteparameters</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-VcfOpsserviceconfigurationdeleteparameters</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Services</maml:name> <maml:Description> <maml:para>Collection of applications service configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationDeleteParameter></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationDeleteParameter></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Services</maml:name> <maml:Description> <maml:para>Collection of applications service configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationDeleteParameter></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ServiceConfigurationDeleteParameter></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ServiceConfigurationDeleteParameter = Initialize-VcfOpsServiceConfigurationDeleteParameter -ServiceName "MyServiceName" -ConfigNames "MyConfigNames" $ServiceConfigurationDeleteParameters = Initialize-VcfOpsServiceConfigurationDeleteParameters -Services $ServiceConfigurationDeleteParameter </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsserviceconfigurationdeleteparameters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ServiceConfigurationDeleteParameter = Initialize-VcfOpsServiceConfigurationDeleteParameter -ServiceName "MyServiceName" -ConfigNames "MyConfigNames" $ServiceConfigurationDeleteParameters = Initialize-VcfOpsServiceConfigurationDeleteParameters -Services $ServiceConfigurationDeleteParameter </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsserviceconfigurationdeleteparameters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ServiceConfigurationDeleteParameters</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsserviceconfigurationsparameters</command:name> <command:verb>Initialize</command:verb> <command:noun>serviceconfigurationsparameters</command:noun> <maml:description> <maml:para>Collection of applications service configurations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Collection of applications service configurations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsserviceconfigurationsparameters</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServiceName</maml:name> <maml:Description> <maml:para>The name of applications service configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Configurations</maml:name> <maml:Description> <maml:para>Collection of applications service configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ServiceConfiguration></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ServiceConfiguration></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ServiceName</maml:name> <maml:Description> <maml:para>The name of applications service configuration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Configurations</maml:name> <maml:Description> <maml:para>Collection of applications service configurations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ServiceConfiguration></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ServiceConfiguration></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $KeyValue = Initialize-VcfOpsKeyValue -Key "MyKey" -Value "MyValue" $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -IsActivated $false -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsserviceconfigurationsparameters with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $KeyValue = Initialize-VcfOpsKeyValue $ServiceConfiguration = Initialize-VcfOpsServiceConfiguration -ConfigName "MyConfigName" -Parameters $KeyValue $ServiceConfigurationsParameters = Initialize-VcfOpsServiceConfigurationsParameters -ServiceName "MyServiceName" -Configurations $ServiceConfiguration </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsserviceconfigurationsparameters with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/ServiceConfigurationsParameters</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsstatcontent</command:name> <command:verb>Initialize</command:verb> <command:noun>statcontent</command:noun> <maml:description> <maml:para>Represents the Stat Content posted by the user.<br>The data posted by the user can be numeric data or string data.<br>However both types of the data cannot be sent together.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the Stat Content posted by the user.<br>The data posted by the user can be numeric data or string data.<br>However both types of the data cannot be sent together.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsstatcontent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatKey</maml:name> <maml:Description> <maml:para>Stat Key for which the data is being posted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Timestamps</maml:name> <maml:Description> <maml:para>The array of timestamps at which the data is being posted. All the timestamps must be in milliseconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<long></command:parameterValue> <dev:type> <maml:name>List<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>Data</maml:name> <maml:Description> <maml:para>The numeric data that is being posted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<double></command:parameterValue> <dev:type> <maml:name>List<double></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Values</maml:name> <maml:Description> <maml:para>The string values that are being posted</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>StatKey</maml:name> <maml:Description> <maml:para>Stat Key for which the data is being posted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Timestamps</maml:name> <maml:Description> <maml:para>The array of timestamps at which the data is being posted. All the timestamps must be in milliseconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<long></command:parameterValue> <dev:type> <maml:name>List<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>Data</maml:name> <maml:Description> <maml:para>The numeric data that is being posted</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<double></command:parameterValue> <dev:type> <maml:name>List<double></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Values</maml:name> <maml:Description> <maml:para>The string values that are being posted</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>$StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatcontent with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatcontent with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/StatContent</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsstatcontents</command:name> <command:verb>Initialize</command:verb> <command:noun>statcontents</command:noun> <maml:description> <maml:para>Represents the Stat Contents posted by the user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the Stat Contents posted by the user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsstatcontents</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatContent</maml:name> <maml:Description> <maml:para>Collection of stat contents</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.StatContent></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.StatContent></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StatContent</maml:name> <maml:Description> <maml:para>Collection of stat contents</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.StatContent></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.StatContent></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 -Data 0 -Values "MyValues" $StatContents = Initialize-VcfOpsStatContents -StatContent $StatContent </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatcontents with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $StatContent = Initialize-VcfOpsStatContent -StatKey "MyStatKey" -Timestamps 0 $StatContents = Initialize-VcfOpsStatContents -StatContent $StatContent </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatcontents with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/StatContents</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsstatorpropertycondition</command:name> <command:verb>Initialize</command:verb> <command:noun>statorpropertycondition</command:noun> <maml:description> <maml:para>Model that represents a Property Condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents a Property Condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsstatorpropertycondition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>The name of the StatKey or Property to which the condition applies</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Operator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StringValue</maml:name> <maml:Description> <maml:para>String value to which we need to compare 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DoubleValue</maml:name> <maml:Description> <maml:para>Double value to which we need to compare to</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 name of the StatKey or Property to which the condition applies</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Operator</maml:name> <maml:Description> <maml:para>Comparison Operator used within the VMware Cloud Foundation Operations Suite API</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StringValue</maml:name> <maml:Description> <maml:para>String value to which we need to compare 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DoubleValue</maml:name> <maml:Description> <maml:para>Double value to which we need to compare to</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatorpropertycondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatorpropertycondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/StatOrPropertyCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsstatorpropertyconditionquery</command:name> <command:verb>Initialize</command:verb> <command:noun>statorpropertyconditionquery</command:noun> <maml:description> <maml:para>Object used to define filtering criteria based on multiple stats/properties with possibility to specify the conjunction operator</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Object used to define filtering criteria based on multiple stats/properties with possibility to specify the conjunction operator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsstatorpropertyconditionquery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConjunctionOperator</maml:name> <maml:Description> <maml:para>Operations for Composite Conditions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Conditions</maml:name> <maml:Description> <maml:para>Array of condition to be used for filtering</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.StatOrPropertyCondition></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.StatOrPropertyCondition></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>ConjunctionOperator</maml:name> <maml:Description> <maml:para>Operations for Composite Conditions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Conditions</maml:name> <maml:Description> <maml:para>Array of condition to be used for filtering</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.StatOrPropertyCondition></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.StatOrPropertyCondition></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatorpropertyconditionquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -Conditions $StatOrPropertyCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatorpropertyconditionquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/StatOrPropertyConditionQuery</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsstatquery</command:name> <command:verb>Initialize</command:verb> <command:noun>statquery</command:noun> <maml:description> <maml:para>Object used to request stats(metrics) on a collection of resources.<br>Defines search criteria as well as expected data set.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Object used to request stats(metrics) on a collection of resources.<br>Defines search criteria as well as expected data set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsstatquery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>VarEnd</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.RollUpType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RollUpType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntervalType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.IntervalType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.IntervalType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>ResourceId</maml:name> <maml:Description> <maml:para>Array of Resource ids for which the stats should be fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>StatKey</maml:name> <maml:Description> <maml:para>Array of stat keys for which the stats should be returned</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>Begin</maml:name> <maml:Description> <maml:para>The beginning date as a long value of the range of stats to return<br>Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: If not provided, 24 hour rearward of ending date is used</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>VarEnd</maml:name> <maml:Description> <maml:para>The ending date as a long value of the range of stats to return<br>Long value is number of milliseconds since January 1, 1970 00:00:00 UTC<br>NOTE: The ending date must not be less than the beginning date.<br>If not provided, current time as UTC milliseconds is used</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>RollUpType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.RollUpType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.RollUpType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntervalType</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.IntervalType</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.IntervalType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IntervalQuantifier</maml:name> <maml:Description> <maml:para>Number for the interval type</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>Dt</maml:name> <maml:Description> <maml:para>Indicates that the requested stats are based on some dynamic threshold.<br><b>Defaults to false which indicates that stats are not based on dynamic threshold.</maml:para> </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>LatestMaxSamples</maml:name> <maml:Description> <maml:para>The maximum number of samples to return when querying latest.<br>When processing the get latest stats query if it is omitted a value of 1 is assumed.<br>A query for the latest samples is not compatible with specifying the RollUpType value.</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>Metrics</maml:name> <maml:Description> <maml:para>Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats)</maml:para> </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>CurrentOnly</maml:name> <maml:Description> <maml:para>Indicates whether to report only \"current\" stat values, i.e. skip the stat-s that haven't published any value<br>during recent collection cycles.</maml:para> </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>WrapStatValues</maml:name> <maml:Description> <maml:para>Indicates whether stat values should be wrapped for application/xml response content type.<br>This flag is false by default and not needed for application/json response.<br>If set to true \"statValues\" will be returned instead of \"values\" for all content types.</maml:para> </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>$StatQuery = Initialize-VcfOpsStatQuery -ResourceId "MyResourceId" -StatKey "MyStatKey" -Begin 0 -End 0 -RollUpType "SUM" -IntervalType "HOURS" -IntervalQuantifier 0 -Dt $false -LatestMaxSamples 0 -Metrics $false -CurrentOnly $false -WrapStatValues $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StatQuery = Initialize-VcfOpsStatQuery </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstatquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/StatQuery</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsstoragepolicyrate</command:name> <command:verb>Initialize</command:verb> <command:noun>storagepolicyrate</command:noun> <maml:description> <maml:para>Storage policy rate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Storage policy rate.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsstoragepolicyrate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StoragePolicyRate = Initialize-VcfOpsStoragePolicyRate -ChargePeriod "HOURLY" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstoragepolicyrate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StoragePolicyRate = Initialize-VcfOpsStoragePolicyRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstoragepolicyrate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/StoragePolicyRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsstrvalues</command:name> <command:verb>Initialize</command:verb> <command:noun>strvalues</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-VcfOpsstrvalues</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Values</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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Values</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>$StrValues = Initialize-VcfOpsStrValues -Values "MyValues" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstrvalues with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StrValues = Initialize-VcfOpsStrValues </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstrvalues with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/StrValues</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsstringpropertycondition</command:name> <command:verb>Initialize</command:verb> <command:noun>stringpropertycondition</command:noun> <maml:description> <maml:para>String Property condition</maml:para> </maml:description> </command:details> <maml:description> <maml:para>String Property condition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsstringpropertycondition</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>$StringPropertyCondition = Initialize-VcfOpsStringPropertyCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstringpropertycondition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StringPropertyCondition = Initialize-VcfOpsStringPropertyCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsstringpropertycondition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/StringPropertyCondition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpssupermetric</command:name> <command:verb>Initialize</command:verb> <command:noun>supermetric</command:noun> <maml:description> <maml:para>Model object that represents a SuperMetric</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model object that represents a SuperMetric</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpssupermetric</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The unique ID of the SuperMetric. This will be null when creating a<br>SuperMetric, but it is required when updating an existing SuperMetric.</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>Name</maml:name> <maml:Description> <maml:para>The name of the SuperMetric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Formula</maml:name> <maml:Description> <maml:para>The formula expression of the SuperMetric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the SuperMetric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ModificationTime</maml:name> <maml:Description> <maml:para>Last modification time of the SuperMetric</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>Id</maml:name> <maml:Description> <maml:para>The unique ID of the SuperMetric. This will be null when creating a<br>SuperMetric, but it is required when updating an existing SuperMetric.</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>Name</maml:name> <maml:Description> <maml:para>The name of the SuperMetric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Formula</maml:name> <maml:Description> <maml:para>The formula expression of the SuperMetric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the SuperMetric</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ModificationTime</maml:name> <maml:Description> <maml:para>Last modification time of the SuperMetric</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>$Supermetric = Initialize-VcfOpsSupermetric -Id "MyId" -Name "MyName" -Formula "MyFormula" -Description "MyDescription" -ModificationTime 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssupermetric with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Supermetric = Initialize-VcfOpsSupermetric -Name "MyName" -Formula "MyFormula" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssupermetric with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/Supermetric</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpssymptomdefinition</command:name> <command:verb>Initialize</command:verb> <command:noun>symptomdefinition</command:noun> <maml:description> <maml:para>A Symptom Definition defines conditions and properties which define when an alarm is triggered</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A Symptom Definition defines conditions and properties which define when an alarm is triggered</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpssymptomdefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier for the SymptomDefinition. Must be null during create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 SymptomDefinition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The adapter kind identifier for the SymptomDefinition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The resource kind identifier for the SymptomDefinition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WaitCycles</maml:name> <maml:Description> <maml:para>The number of consecutive cycles to wait when a symptom state is true before a symptom is triggered</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>CancelCycles</maml:name> <maml:Description> <maml:para>The number of consecutive cycles to wait when a symptom state is false before a symptom is cancelled</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>RealtimeMonitoringEnabled</maml:name> <maml:Description> <maml:para>Indicates whether real-time monitoring is enabled for the symptom or not. (This field is only visible in SaaS)</maml:para> </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>State</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.SymptomState</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomState</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 identifier for the SymptomDefinition. Must be null during create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 SymptomDefinition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKindKey</maml:name> <maml:Description> <maml:para>The adapter kind identifier for the SymptomDefinition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKindKey</maml:name> <maml:Description> <maml:para>The resource kind identifier for the SymptomDefinition</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WaitCycles</maml:name> <maml:Description> <maml:para>The number of consecutive cycles to wait when a symptom state is true before a symptom is triggered</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>CancelCycles</maml:name> <maml:Description> <maml:para>The number of consecutive cycles to wait when a symptom state is false before a symptom is cancelled</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>RealtimeMonitoringEnabled</maml:name> <maml:Description> <maml:para>Indicates whether real-time monitoring is enabled for the symptom or not. (This field is only visible in SaaS)</maml:para> </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>State</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.SymptomState</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.SymptomState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $OneOfCondition = Initialize-VcfOpsOneOfCondition $SymptomState = Initialize-VcfOpsSymptomState -Severity "UNKNOWN" -Condition $OneOfCondition $SymptomDefinition = Initialize-VcfOpsSymptomDefinition -Id "MyId" -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -WaitCycles 0 -CancelCycles 0 -RealtimeMonitoringEnabled $false -State $SymptomState </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssymptomdefinition with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $OneOfCondition = Initialize-VcfOpsOneOfCondition $SymptomState = Initialize-VcfOpsSymptomState -Severity "UNKNOWN" -Condition $OneOfCondition $SymptomDefinition = Initialize-VcfOpsSymptomDefinition -Name "MyName" -AdapterKindKey "MyAdapterKindKey" -ResourceKindKey "MyResourceKindKey" -State $SymptomState </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssymptomdefinition with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/SymptomDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpssymptomstate</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-VcfOpssymptomquery</command:name> <command:verb>Initialize</command:verb> <command:noun>symptomquery</command:noun> <maml:description> <maml:para>Query for Symptoms using various criteria.<br>Composition of filtering criteria controlled via the <i>compositeOperator<i> property.<br>Pagination of the Symptoms that are returned can be controlled via the <i>PageInfo</i> object.<br>Sorting of the Symptoms is specified via the <i>SymptomField</i> object and the <i>SortOrder</i><br>object controls the order in which the Symptoms are sorted.<br>If a sort field is not specified but pagination is requested the Symptoms will be sorted<br>by the <b><i>alarmId</i></b> property.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Query for Symptoms using various criteria.<br>Composition of filtering criteria controlled via the <i>compositeOperator<i> property.<br>Pagination of the Symptoms that are returned can be controlled via the <i>PageInfo</i> object.<br>Sorting of the Symptoms is specified via the <i>SymptomField</i> object and the <i>SortOrder</i><br>object controls the order in which the Symptoms are sorted.<br>If a sort field is not specified but pagination is requested the Symptoms will be sorted<br>by the <b><i>alarmId</i></b> property.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpssymptomquery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CompositeOperator</maml:name> <maml:Description> <maml:para>Operations for Composite Conditions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomId</maml:name> <maml:Description> <maml:para>Return Symptoms that have the specified list of Symptom identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceQuery</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeChildrenResources</maml:name> <maml:Description> <maml:para>Whether to include Symptoms of all the children of resources identified by <i>resourceIds</i></maml:para> </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>ActiveOnly</maml:name> <maml:Description> <maml:para>Include Symptoms that are currently Active.<br>By default, only active Symptoms are included in the result</maml:para> </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>IncludeAlarmInfo</maml:name> <maml:Description> <maml:para>Boolean that controls the retrieval of alarm information of the symptom</maml:para> </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>AlarmType</maml:name> <maml:Description> <maml:para>Return Symptoms that have the specified list of Symptom Types</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>AlarmCriticality</maml:name> <maml:Description> <maml:para>Return Symptoms that have the specified list of Symptom Criticalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SymptomQuery.AlarmCriticalityEnum></command:parameterValue> <dev:type> <maml:name>List<SymptomQuery.AlarmCriticalityEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CancelTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomDefinitionId</maml:name> <maml:Description> <maml:para>Return Symptoms that have the specified list of Symptom Definitions</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>StatKey</maml:name> <maml:Description> <maml:para>Return Symptoms that have been generated because of violations on the Stat Keys specified</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>CompositeOperator</maml:name> <maml:Description> <maml:para>Operations for Composite Conditions</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomId</maml:name> <maml:Description> <maml:para>Return Symptoms that have the specified list of Symptom identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>ResourceQuery</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceQuery</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceQuery</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IncludeChildrenResources</maml:name> <maml:Description> <maml:para>Whether to include Symptoms of all the children of resources identified by <i>resourceIds</i></maml:para> </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>ActiveOnly</maml:name> <maml:Description> <maml:para>Include Symptoms that are currently Active.<br>By default, only active Symptoms are included in the result</maml:para> </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>IncludeAlarmInfo</maml:name> <maml:Description> <maml:para>Boolean that controls the retrieval of alarm information of the symptom</maml:para> </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>AlarmType</maml:name> <maml:Description> <maml:para>Return Symptoms that have the specified list of Symptom Types</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<int></command:parameterValue> <dev:type> <maml:name>List<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>AlarmCriticality</maml:name> <maml:Description> <maml:para>Return Symptoms that have the specified list of Symptom Criticalities</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<SymptomQuery.AlarmCriticalityEnum></command:parameterValue> <dev:type> <maml:name>List<SymptomQuery.AlarmCriticalityEnum></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CancelTimeRange</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TimeRange</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TimeRange</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SymptomDefinitionId</maml:name> <maml:Description> <maml:para>Return Symptoms that have the specified list of Symptom Definitions</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>StatKey</maml:name> <maml:Description> <maml:para>Return Symptoms that have been generated because of violations on the Stat Keys specified</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> $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag "UNKNOWN"$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 $SymptomQuery = Initialize-VcfOpsSymptomQuery -CompositeOperator "AND" -SymptomId "MySymptomId" -ResourceQuery $ResourceQuery -IncludeChildrenResources $false -ActiveOnly $false -IncludeAlarmInfo $false -AlarmType 0 -AlarmCriticality $StatOrPropertyCondition = Initialize-VcfOpsStatOrPropertyCondition -Key "MyKey" -Operator "EQ" -StringValue "MyStringValue" -DoubleValue 0 $StatOrPropertyConditionQuery = Initialize-VcfOpsStatOrPropertyConditionQuery -ConjunctionOperator "AND" -Conditions $StatOrPropertyCondition $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $ResourceQuery = Initialize-VcfOpsResourceQuery -Name "MyName" -Regex "MyRegex" -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -CollectorName "MyCollectorName" -CollectorId 0 -MaintenanceScheduleId "MyMaintenanceScheduleId" -AdapterInstanceId "MyAdapterInstanceId" -RecentlyAdded 0 -ResourceState "STOPPED" -ResourceStatus "NONE" -ResourceHealth "GREEN" -ParentId "MyParentId" -CredentialId "MyCredentialId" -ResourceId "MyResourceId" -PropertyName "MyPropertyName" -PropertyValue "MyPropertyValue" -StatKey "MyStatKey" -StatKeyLowerBound 0 -StatKeyUpperBound 0 -StatKeyInclusive $false -PropertyConditions $StatOrPropertyConditionQuery -StatConditions $StatOrPropertyConditionQuery -IncludeRelated "PARENT" -ResourceTag $ResourceTag "UNKNOWN" -StartTimeRange $TimeRange -CancelTimeRange $TimeRange -SymptomDefinitionId "MySymptomDefinitionId" -StatKey "MyStatKey" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssymptomquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $SymptomQuery = Initialize-VcfOpsSymptomQuery </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssymptomquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/SymptomQuery</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcequery</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstimerange</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstimerange</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-VcfOpssymptomset</command:name> <command:verb>Initialize</command:verb> <command:noun>symptomset</command:noun> <maml:description> <maml:para>A reference to the symptoms by <i>symptomDefinitionReferences</i> which is full of symptom definition id values, on a related resource found by the relation.<br></maml:para> </maml:description> </command:details> <maml:description> <maml:para>A reference to the symptoms by <i>symptomDefinitionReferences</i> which is full of symptom definition id values, on a related resource found by the relation.<br></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpssymptomset</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {SYMPTOM_SET_COMPOSITE, SYMPTOM_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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {SYMPTOM_SET_COMPOSITE, SYMPTOM_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>$SymptomSet = Initialize-VcfOpsSymptomSet -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssymptomset with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SymptomSet = Initialize-VcfOpsSymptomSet </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssymptomset with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/SymptomSet</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpssymptomstate</command:name> <command:verb>Initialize</command:verb> <command:noun>symptomstate</command:noun> <maml:description> <maml:para>The SymptomState is a product of the severity and a condition. A symptom definition may have one SymptomState per severity level.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The SymptomState is a product of the severity and a condition. A symptom definition may have one SymptomState per severity level.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpssymptomstate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Severity</maml:name> <maml:Description> <maml:para>The Criticality level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Condition</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfCondition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfCondition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Severity</maml:name> <maml:Description> <maml:para>The Criticality level</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Condition</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfCondition</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfCondition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $OneOfCondition = Initialize-VcfOpsOneOfCondition $SymptomState = Initialize-VcfOpsSymptomState -Severity "UNKNOWN" -Condition $OneOfCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssymptomstate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $OneOfCondition = Initialize-VcfOpsOneOfCondition $SymptomState = Initialize-VcfOpsSymptomState -Severity "UNKNOWN" -Condition $OneOfCondition </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpssymptomstate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/SymptomState</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsOneOfCondition</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-VcfOpstagbasedmeteringrate</command:name> <command:verb>Initialize</command:verb> <command:noun>tagbasedmeteringrate</command:noun> <maml:description> <maml:para>Model representing tag based rate</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing tag based rate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpstagbasedmeteringrate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>ChargePeriod</maml:name> <maml:Description> <maml:para>Indicates policy pricing charge period settings</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>Base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {basic-rate, named-rate, named-charged-power-state-rate, charge-type-additional-rate, network-rate, fix-cost-rate, tag-based-metering-rate, charge-type-power-state-rate, storage-policy-rate, named-charged-power-state-rate}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TagBasedMeteringRate = Initialize-VcfOpsTagBasedMeteringRate -ChargePeriod "HOURLY" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstagbasedmeteringrate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TagBasedMeteringRate = Initialize-VcfOpsTagBasedMeteringRate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstagbasedmeteringrate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/TagBasedMeteringRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpstagbasedrate</command:name> <command:verb>Initialize</command:verb> <command:noun>tagbasedrate</command:noun> <maml:description> <maml:para>Model representing tag based rate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing tag based rate.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpstagbasedrate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>key of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>value of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>value of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {vc-tag-based-rate-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: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>key of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>value of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>value of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {vc-tag-based-rate-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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TagBasedRate = Initialize-VcfOpsTagBasedRate -Key "MyKey" -Value "MyValue" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstagbasedrate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TagBasedRate = Initialize-VcfOpsTagBasedRate -Key "MyKey" -Value "MyValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstagbasedrate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/TagBasedRate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpstaggroup</command:name> <command:verb>Initialize</command:verb> <command:noun>taggroup</command:noun> <maml:description> <maml:para>Represents the data for tag group settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the data for tag group settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpstaggroup</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 tag group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Prioritized</maml:name> <maml:Description> <maml:para>Specifies whether prioritization is enabled for the group 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>ResourceTags</maml:name> <maml:Description> <maml:para>Collection of resource tag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceTag></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceTag></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 tag group</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Prioritized</maml:name> <maml:Description> <maml:para>Specifies whether prioritization is enabled for the group 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>ResourceTags</maml:name> <maml:Description> <maml:para>Collection of resource tag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceTag></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceTag></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $TagGroup = Initialize-VcfOpsTagGroup -Name "MyName" -Prioritized $false -ResourceTags $ResourceTag </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstaggroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $TagGroup = Initialize-VcfOpsTagGroup -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstaggroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/TagGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpstargetnetworksettings</command:name> <command:verb>Initialize</command:verb> <command:noun>targetnetworksettings</command:noun> <maml:description> <maml:para>Model representing generate target network mapping settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing generate target network mapping settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpstargetnetworksettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$TargetNetworkSettings = Initialize-VcfOpsTargetNetworkSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstargetnetworksettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TargetNetworkSettings = Initialize-VcfOpsTargetNetworkSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstargetnetworksettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/TargetNetworkSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpstemplatecontentconfig</command:name> <command:verb>Initialize</command:verb> <command:noun>templatecontentconfig</command:noun> <maml:description> <maml:para>Model that represents a template content config.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents a template content config.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpstemplatecontentconfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseResourceKindKeyStats</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AncestorResourceKindKeys</maml:name> <maml:Description> <maml:para>Ancestor resource kind keys and stats selected for them</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DescendantResourceKindKeys</maml:name> <maml:Description> <maml:para>Descendant resource kind keys and stats selected for them</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BaseResourceKindKeyStats</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AncestorResourceKindKeys</maml:name> <maml:Description> <maml:para>Ancestor resource kind keys and stats selected for them</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DescendantResourceKindKeys</maml:name> <maml:Description> <maml:para>Descendant resource kind keys and stats selected for them</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceKindKeyStats></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceKindKey = Initialize-VcfOpsResourceKindKey -ResourceKind "MyResourceKind" -AdapterKind "MyAdapterKind" $ResourceKindKeyStats = Initialize-VcfOpsResourceKindKeyStats -ResourceKindKey $ResourceKindKey -Stats "MyStats" $TemplateContentConfig = Initialize-VcfOpsTemplateContentConfig -BaseResourceKindKeyStats $ResourceKindKeyStats -AncestorResourceKindKeys $ResourceKindKeyStats -DescendantResourceKindKeys $ResourceKindKeyStats </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstemplatecontentconfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ResourceKindKeyStats = Initialize-VcfOpsResourceKindKeyStats $TemplateContentConfig = Initialize-VcfOpsTemplateContentConfig -BaseResourceKindKeyStats $ResourceKindKeyStats </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstemplatecontentconfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/TemplateContentConfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsresourcekindkeystats</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-VcfOpstemplateproperty</command:name> <command:verb>Initialize</command:verb> <command:noun>templateproperty</command:noun> <maml:description> <maml:para>Model that represents a notification template property.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents a notification template property.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpstemplateproperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>Property 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>Name</maml:name> <maml:Description> <maml:para>Property 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>Type</maml:name> <maml:Description> <maml:para>Enumerated type for template property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>Property 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: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>Property 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>Name</maml:name> <maml:Description> <maml:para>Property 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>Type</maml:name> <maml:Description> <maml:para>Enumerated type for template property</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml: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>Property 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TemplateProperty = Initialize-VcfOpsTemplateProperty -Key "MyKey" -Name "MyName" -Type "STRING" -Description "MyDescription" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstemplateproperty with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TemplateProperty = Initialize-VcfOpsTemplateProperty -Key "MyKey" -Name "MyName" -Type "STRING" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstemplateproperty with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/TemplateProperty</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpstimerange</command:name> <command:verb>Initialize</command:verb> <command:noun>timerange</command:noun> <maml:description> <maml:para>Filter based on matching UTC cancel time</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Filter based on matching UTC cancel time</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpstimerange</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartTime</maml:name> <maml:Description> <maml:para>UTC start time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ulong</command:parameterValue> <dev:type> <maml:name>ulong</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EndTime</maml:name> <maml:Description> <maml:para>UTC end time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ulong</command:parameterValue> <dev:type> <maml:name>ulong</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>StartTime</maml:name> <maml:Description> <maml:para>UTC start time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ulong</command:parameterValue> <dev:type> <maml:name>ulong</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EndTime</maml:name> <maml:Description> <maml:para>UTC end time</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ulong</command:parameterValue> <dev:type> <maml:name>ulong</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$TimeRange = Initialize-VcfOpsTimeRange -StartTime 0 -EndTime 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstimerange with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TimeRange = Initialize-VcfOpsTimeRange </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstimerange with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/TimeRange</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpstraversalspec</command:name> <command:verb>Initialize</command:verb> <command:noun>traversalspec</command:noun> <maml:description> <maml:para>Represents traversal specs. These are templates in the system using which admins can assign specific set of resources to their users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents traversal specs. These are templates in the system using which admins can assign specific set of resources to their users.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpstraversalspec</maml:name> <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 traversal spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the traversal spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RootAdapterKindKey</maml:name> <maml:Description> <maml:para>The adapter kind of the root 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>RootResourceKindKey</maml:name> <maml:Description> <maml:para>The resource kind of the root 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>AdapterInstanceAssociation</maml:name> <maml:Description> <maml:para>When true the traversal spec templates applies to adapter kind associations. A traversal spec instance based on this template must specify the included adapter kinds it applies to.</maml:para> </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>Name</maml:name> <maml:Description> <maml:para>The name of the traversal spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 description of the traversal spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>RootAdapterKindKey</maml:name> <maml:Description> <maml:para>The adapter kind of the root 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>RootResourceKindKey</maml:name> <maml:Description> <maml:para>The resource kind of the root 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>AdapterInstanceAssociation</maml:name> <maml:Description> <maml:para>When true the traversal spec templates applies to adapter kind associations. A traversal spec instance based on this template must specify the included adapter kinds it applies to.</maml:para> </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>$TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" -Description "MyDescription" -RootAdapterKindKey "MyRootAdapterKindKey" -RootResourceKindKey "MyRootResourceKindKey" -AdapterInstanceAssociation $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstraversalspec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$TraversalSpec = Initialize-VcfOpsTraversalSpec -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstraversalspec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/TraversalSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpstraversalspecinstance</command:name> <command:verb>Initialize</command:verb> <command:noun>traversalspecinstance</command:noun> <maml:description> <maml:para>Represents traversal spec type. This can be used by users and user groups in a permission objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents traversal spec type. This can be used by users and user groups in a permission objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpstraversalspecinstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AdapterKind</maml:name> <maml:Description> <maml:para>The root Adapter kind of the Traversal Specification. Together with <code>resourceKind</code> and <code>name</code> these values uniquely identify the traversal specification used by this 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>The root Resource kind of the Traversal Specification. Together with <code>adapterKind</code> and <code>name</code> these values uniquely identify a traversal specification used by this 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>Name</maml:name> <maml:Description> <maml:para>The name of the Traversal Specification. Together with <code>adapterKind</code> and <code>resourceKind</code> these values uniquely identify a traversal specification used by this 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceSelection</maml:name> <maml:Description> <maml:para>List of root resource id selections</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceSelection></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceSelection></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SelectAllResources</maml:name> <maml:Description> <maml:para>When flag is true system will ignore resource selections and include all resources in the tree defined by the traversal specification templat.</maml:para> </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>IncludedAdapterKinds</maml:name> <maml:Description> <maml:para>The adapter kinds that apply to this traversal specification instance. <b>Only</b> applicable for traversal specification templates with a filter type of ADAPTER_ASSOCIATION. If this is present, then all adapter instances of this kind are selected as part of the hierarchy.</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>AdapterKind</maml:name> <maml:Description> <maml:para>The root Adapter kind of the Traversal Specification. Together with <code>resourceKind</code> and <code>name</code> these values uniquely identify the traversal specification used by this 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceKind</maml:name> <maml:Description> <maml:para>The root Resource kind of the Traversal Specification. Together with <code>adapterKind</code> and <code>name</code> these values uniquely identify a traversal specification used by this 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>Name</maml:name> <maml:Description> <maml:para>The name of the Traversal Specification. Together with <code>adapterKind</code> and <code>resourceKind</code> these values uniquely identify a traversal specification used by this 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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ResourceSelection</maml:name> <maml:Description> <maml:para>List of root resource id selections</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.ResourceSelection></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.ResourceSelection></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SelectAllResources</maml:name> <maml:Description> <maml:para>When flag is true system will ignore resource selections and include all resources in the tree defined by the traversal specification templat.</maml:para> </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>IncludedAdapterKinds</maml:name> <maml:Description> <maml:para>The adapter kinds that apply to this traversal specification instance. <b>Only</b> applicable for traversal specification templates with a filter type of ADAPTER_ASSOCIATION. If this is present, then all adapter instances of this kind are selected as part of the hierarchy.</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> $ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstraversalspecinstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpstraversalspecinstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/TraversalSpecInstance</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsuser</command:name> <command:verb>Initialize</command:verb> <command:noun>user</command:noun> <maml:description> <maml:para>Represents a local user of VMware Cloud Foundation Operations system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a local user of VMware Cloud Foundation Operations system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsuser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier of the user in the system.</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>Username</maml:name> <maml:Description> <maml:para>Username of the current 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>FirstName</maml:name> <maml:Description> <maml:para>First name of the current 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>LastName</maml:name> <maml:Description> <maml:para>The last name of the current 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>Password</maml:name> <maml:Description> <maml:para>Password of the user object. When creating a new local user, this field has to be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>The email address of the current 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>DistinguishedName</maml:name> <maml:Description> <maml:para>distinguished name of the current 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>Enabled</maml:name> <maml:Description> <maml:para>Is the current user's account 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>GroupIds</maml:name> <maml:Description> <maml:para>The list of group ids to which the current user belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RoleNames</maml:name> <maml:Description> <maml:para>(Deprecated) List of role names assigned to the user. May be null.</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>RolePermissions</maml:name> <maml:Description> <maml:para>List of role permissions assigned to this user. May be null. Replaces and takes precedence over <code>roleNames</code></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.RolePermission></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.RolePermission></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LastLoginTime</maml:name> <maml:Description> <maml:para>Last login time</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>ExternalId</maml:name> <maml:Description> <maml:para>External ID of vIDB user. This field is only used in vIDB user import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></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>Identifier of the user in the system.</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>Username</maml:name> <maml:Description> <maml:para>Username of the current 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>FirstName</maml:name> <maml:Description> <maml:para>First name of the current 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>LastName</maml:name> <maml:Description> <maml:para>The last name of the current 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>Password</maml:name> <maml:Description> <maml:para>Password of the user object. When creating a new local user, this field has to be specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:Description> <maml:para>The email address of the current 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>DistinguishedName</maml:name> <maml:Description> <maml:para>distinguished name of the current 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>Enabled</maml:name> <maml:Description> <maml:para>Is the current user's account 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>GroupIds</maml:name> <maml:Description> <maml:para>The list of group ids to which the current user belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RoleNames</maml:name> <maml:Description> <maml:para>(Deprecated) List of role names assigned to the user. May be null.</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>RolePermissions</maml:name> <maml:Description> <maml:para>List of role permissions assigned to this user. May be null. Replaces and takes precedence over <code>roleNames</code></maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.RolePermission></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.RolePermission></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>LastLoginTime</maml:name> <maml:Description> <maml:para>Last login time</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>ExternalId</maml:name> <maml:Description> <maml:para>External ID of vIDB user. This field is only used in vIDB user import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link $User = Initialize-VcfOpsUser -Id "MyId" -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Password "MyPassword" -EmailAddress "MyEmailAddress" -DistinguishedName "MyDistinguishedName" -Enabled $false -GroupIds "MyGroupIds" -RoleNames "MyRoleNames" -RolePermissions $RolePermission -LastLoginTime 0 -ExternalId "MyExternalId" -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsuser with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $User = Initialize-VcfOpsUser -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsuser with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/User</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsusergroup</command:name> <command:verb>Initialize</command:verb> <command:noun>usergroup</command:noun> <maml:description> <maml:para>Represents a user group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a user group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsusergroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The identifier of this group.(unique)<br><br><b>Note:</b>&nbsp;Required when updating or deleting the user group.</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>AuthSourceId</maml:name> <maml:Description> <maml:para>The identifier of the auth source. If it is null, a local user group will be created.</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>Name</maml:name> <maml:Description> <maml:para>The name of this group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>A description about this group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>The displayName of this group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserIds</maml:name> <maml:Description> <maml:para>The list of users who are members of this group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RoleNames</maml:name> <maml:Description> <maml:para>(Deprecated) List of role names assigned to the user group. May be null.</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>RolePermissions</maml:name> <maml:Description> <maml:para>The list of role permissions assigned to this group. May be null. Replaces and takes precedence over <code>roleNames</code>.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.RolePermission></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.RolePermission></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExternalId</maml:name> <maml:Description> <maml:para>External ID of vIDB user group. This field is only used in vIDB user group import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></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 identifier of this group.(unique)<br><br><b>Note:</b>&nbsp;Required when updating or deleting the user group.</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>AuthSourceId</maml:name> <maml:Description> <maml:para>The identifier of the auth source. If it is null, a local user group will be created.</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>Name</maml:name> <maml:Description> <maml:para>The name of this group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>A description about this group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>The displayName of this group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UserIds</maml:name> <maml:Description> <maml:para>The list of users who are members of this group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>RoleNames</maml:name> <maml:Description> <maml:para>(Deprecated) List of role names assigned to the user group. May be null.</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>RolePermissions</maml:name> <maml:Description> <maml:para>The list of role permissions assigned to this group. May be null. Replaces and takes precedence over <code>roleNames</code>.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.RolePermission></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.RolePermission></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExternalId</maml:name> <maml:Description> <maml:para>External ID of vIDB user group. This field is only used in vIDB user group import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link $UserGroup = Initialize-VcfOpsUserGroup -Id "MyId" -AuthSourceId "MyAuthSourceId" -Name "MyName" -Description "MyDescription" -DisplayName "MyDisplayName" -UserIds "MyUserIds" -RoleNames "MyRoleNames" -RolePermissions $RolePermission -ExternalId "MyExternalId" -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsusergroup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $UserGroup = Initialize-VcfOpsUserGroup -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsusergroup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/UserGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsuserlist</command:name> <command:verb>Initialize</command:verb> <command:noun>userlist</command:noun> <maml:description> <maml:para>Represents a list of users</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a list of users</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsuserlist</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Users</maml:name> <maml:Description> <maml:para>List of users</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.User></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.User></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>Users</maml:name> <maml:Description> <maml:para>List of users</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.User></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $ResourceSelection = Initialize-VcfOpsResourceSelection -Type "PROPAGATE" -ResourceId "MyResourceId" $TraversalSpecInstance = Initialize-VcfOpsTraversalSpecInstance -AdapterKind "MyAdapterKind" -ResourceKind "MyResourceKind" -Name "MyName" -ResourceSelection $ResourceSelection -SelectAllResources $false -IncludedAdapterKinds "MyIncludedAdapterKinds" $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $RolePermission = Initialize-VcfOpsRolePermission -RoleName "MyRoleName" -ScopeId "MyScopeId" -TraversalSpecInstances $TraversalSpecInstance -AllowAllObjects $false -Links $Link $User = Initialize-VcfOpsUser -Id "MyId" -Username "MyUsername" -FirstName "MyFirstName" -LastName "MyLastName" -Password "MyPassword" -EmailAddress "MyEmailAddress" -DistinguishedName "MyDistinguishedName" -Enabled $false -GroupIds "MyGroupIds" -RoleNames "MyRoleNames" -RolePermissions $RolePermission -LastLoginTime 0 -ExternalId "MyExternalId" -Links $Link $UserList = Initialize-VcfOpsUserList -Users $User </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsuserlist with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $UserList = Initialize-VcfOpsUserList </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsuserlist with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/UserList</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsuserrole</command:name> <command:verb>Initialize</command:verb> <command:noun>userrole</command:noun> <maml:description> <maml:para>Represents a role object in the system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents a role object in the system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsuserrole</maml:name> <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 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The description for 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>A role name suitable for display.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrivilegeKeys</maml:name> <maml:Description> <maml:para>The collection of privilege keys</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>SystemCreated</maml:name> <maml:Description> <maml:para>True if this role was created by the system</maml:para> </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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 name 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The description for 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>A role name suitable for display.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PrivilegeKeys</maml:name> <maml:Description> <maml:para>The collection of privilege keys</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>SystemCreated</maml:name> <maml:Description> <maml:para>True if this role was created by the system</maml:para> </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>Links</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Link></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Link></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $Link = Initialize-VcfOpsLink -Href "MyHref" -Rel "NEXT" -Name "MyName" -Description "MyDescription" $UserRole = Initialize-VcfOpsUserRole -Name "MyName" -Description "MyDescription" -DisplayName "MyDisplayName" -PrivilegeKeys "MyPrivilegeKeys" -SystemCreated $false -Links $Link </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsuserrole with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $UserRole = Initialize-VcfOpsUserRole -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsuserrole with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/UserRole</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsusersearchrequest</command:name> <command:verb>Initialize</command:verb> <command:noun>usersearchrequest</command:noun> <maml:description> <maml:para>The request object to search users</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The request object to search users</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsusersearchrequest</maml:name> <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 to be searched. Can contain wildcards</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 auth source domain. Mandatory for an sso auth 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>Name</maml:name> <maml:Description> <maml:para>The name of the user to be searched. Can contain wildcards</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 auth source domain. Mandatory for an sso auth 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UserSearchRequest = Initialize-VcfOpsUserSearchRequest -Name "MyName" -Domain "MyDomain" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsusersearchrequest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UserSearchRequest = Initialize-VcfOpsUserSearchRequest -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsusersearchrequest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/UserSearchRequest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsusergroupsearchrequest</command:name> <command:verb>Initialize</command:verb> <command:noun>usergroupsearchrequest</command:noun> <maml:description> <maml:para>The request object to search user groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The request object to search user groups</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsusergroupsearchrequest</maml:name> <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 group to be searched. Can contain wildcards</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 auth source domain. Mandatory for an sso auth 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>Name</maml:name> <maml:Description> <maml:para>The name of the user group to be searched. Can contain wildcards</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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 auth source domain. Mandatory for an sso auth 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UsergroupSearchRequest = Initialize-VcfOpsUsergroupSearchRequest -Name "MyName" -Domain "MyDomain" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsusergroupsearchrequest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UsergroupSearchRequest = Initialize-VcfOpsUsergroupSearchRequest -Name "MyName" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsusergroupsearchrequest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/UsergroupSearchRequest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsusernamepassword</command:name> <command:verb>Initialize</command:verb> <command:noun>usernamepassword</command:noun> <maml:description> <maml:para>Represents model of Username and Password</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents model of Username and Password</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsusernamepassword</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>The 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>AuthSource</maml:name> <maml:Description> <maml:para>The auth source 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>The 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>Username</maml:name> <maml:Description> <maml:para>The 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>AuthSource</maml:name> <maml:Description> <maml:para>The auth source 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>The 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>$UsernamePassword = Initialize-VcfOpsUsernamePassword -Username "MyUsername" -AuthSource "MyAuthSource" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsusernamepassword with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UsernamePassword = Initialize-VcfOpsUsernamePassword -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsusernamepassword with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/UsernamePassword</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsuuidvalues</command:name> <command:verb>Initialize</command:verb> <command:noun>uuidvalues</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-VcfOpsuuidvalues</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Uuids</maml:name> <maml:Description> <maml:para>Represents a list of UUID(s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>Uuids</maml:name> <maml:Description> <maml:para>Represents a list of UUID(s)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsuuidvalues with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UuidValues = Initialize-VcfOpsUuidValues -Uuids "MyUuids" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsuuidvalues with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/UuidValues</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsVCFDomain</command:name> <command:verb>Initialize</command:verb> <command:noun>VCFDomain</command:noun> <maml:description> <maml:para>A model that serves as the structure of the payload data for updating VCF domain information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A model that serves as the structure of the payload data for updating VCF domain information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsVCFDomain</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VcfDomainVcenter</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFDomainVcenter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFDomainVcenter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtIntegration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NSXTIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NSXTIntegration</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>VcfDomainVcenter</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VCFDomainVcenter</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VCFDomainVcenter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NsxtIntegration</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.NSXTIntegration</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.NSXTIntegration</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VCFDomainVcenter = Initialize-VcfOpsVCFDomainVcenter $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $NSXTIntegration = Initialize-VcfOpsNSXTIntegration -Url "MyUrl" -Certificates $Certificate -Enabled $false -Id "MyId" -CredentialId "MyCredentialId" -ServiceCredentialsUsed $false $VCFDomain = Initialize-VcfOpsVCFDomain -VcfDomainVcenter $VCFDomainVcenter -NsxtIntegration $NSXTIntegration </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVCFDomain with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VCFDomain = Initialize-VcfOpsVCFDomain </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVCFDomain with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VCFDomain</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsVCFDomainVcenter</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsNSXTIntegration</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-VcfOpsVCFDomainVcenter</command:name> <command:verb>Initialize</command:verb> <command:noun>VCFDomainVcenter</command:noun> <maml:description> <maml:para>A model that serves as the structure of the payload data for VCF domain's vCenter integration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A model that serves as the structure of the payload data for VCF domain's vCenter integration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsVCFDomainVcenter</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>$VCFDomainVcenter = Initialize-VcfOpsVCFDomainVcenter </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVCFDomainVcenter with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VCFDomainVcenter = Initialize-VcfOpsVCFDomainVcenter </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVCFDomainVcenter with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VCFDomainVcenter</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsVCFIntegration</command:name> <command:verb>Initialize</command:verb> <command:noun>VCFIntegration</command:noun> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating or updating VCF integration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating or updating VCF integration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsVCFIntegration</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 existing cloud account integration, must be null at creation</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>Name</maml:name> <maml:Description> <maml:para>The name of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Optional description of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The Collector instance used by this cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>The Collector Group ID to be used for this cloud account integration</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>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>Cloud account integration specific resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>List of new trusted certificates, must be provided upon creation/update of new cloud account integration, for establishing connection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialInstanceId</maml:name> <maml:Description> <maml:para>Credential Instance identifier, for this cloud account integration.</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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of existing cloud account integration, must be null at creation</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>Name</maml:name> <maml:Description> <maml:para>The name of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Optional description of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The Collector instance used by this cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>The Collector Group ID to be used for this cloud account integration</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>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>Cloud account integration specific resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>List of new trusted certificates, must be provided upon creation/update of new cloud account integration, for establishing connection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialInstanceId</maml:name> <maml:Description> <maml:para>Credential Instance identifier, for this cloud account integration.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $VCFIntegration = Initialize-VcfOpsVCFIntegration -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -ResourceIdentifiers $NameValue -Certificates $Certificate -CredentialInstanceId "MyCredentialInstanceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVCFIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VCFIntegration = Initialize-VcfOpsVCFIntegration </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVCFIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VCFIntegration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsvcguestosratesettings</command:name> <command:verb>Initialize</command:verb> <command:noun>vcguestosratesettings</command:noun> <maml:description> <maml:para>Model representing guest OS rate settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing guest OS rate settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsvcguestosratesettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$VcGuestOsRateSettings = Initialize-VcfOpsVcGuestOsRateSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcguestosratesettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VcGuestOsRateSettings = Initialize-VcfOpsVcGuestOsRateSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcguestosratesettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VcGuestOsRateSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsvcpricingsettings</command:name> <command:verb>Initialize</command:verb> <command:noun>vcpricingsettings</command:noun> <maml:description> <maml:para>Model representing VC pricing settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing VC pricing settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsvcpricingsettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PricingPolicyStatus</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PricingPolicyStatusSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PricingPolicyStatusSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BasicCharges</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfBasicChargesSetting</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfBasicChargesSetting</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GuestOSRate</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcGuestOsRateSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcGuestOsRateSettings</maml:name> <maml: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>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PricingTagsSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PricingTagsSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OverallCharges</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OverallChargesSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OverallChargesSettings</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>PricingPolicyStatus</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PricingPolicyStatusSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PricingPolicyStatusSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BasicCharges</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OneOfBasicChargesSetting</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OneOfBasicChargesSetting</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>GuestOSRate</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.VcGuestOsRateSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.VcGuestOsRateSettings</maml:name> <maml: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>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.PricingTagsSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.PricingTagsSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>OverallCharges</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.OverallChargesSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.OverallChargesSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PricingPolicyStatusSettings = Initialize-VcfOpsPricingPolicyStatusSettings -PolicyId "MyPolicyId" -Inherited $false $OneOfBasicChargesSetting = Initialize-VcfOpsOneOfBasicChargesSetting $VcGuestOsRateSettings = Initialize-VcfOpsVcGuestOsRateSettings -PolicyId "MyPolicyId" -Inherited $false $PricingTagsSettings = Initialize-VcfOpsPricingTagsSettings -PolicyId "MyPolicyId" -Inherited $false $OverallChargesSettings = Initialize-VcfOpsOverallChargesSettings -PolicyId "MyPolicyId" -Inherited $false $VcPricingSettings = Initialize-VcfOpsVcPricingSettings -PricingPolicyStatus $PricingPolicyStatusSettings -BasicCharges $OneOfBasicChargesSetting -GuestOSRate $VcGuestOsRateSettings -Tags $PricingTagsSettings -OverallCharges $OverallChargesSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcpricingsettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VcPricingSettings = Initialize-VcfOpsVcPricingSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcpricingsettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VcPricingSettings</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspricingpolicystatussettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsOneOfBasicChargesSetting</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsvcguestosratesettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpspricingtagssettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsoverallchargessettings</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-VcfOpsvctagbasedratefactor</command:name> <command:verb>Initialize</command:verb> <command:noun>vctagbasedratefactor</command:noun> <maml:description> <maml:para>Model representing VC tag based rate factor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing VC tag based rate factor.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsvctagbasedratefactor</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>key of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>value of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>value of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {vc-tag-based-rate-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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>key of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>value of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rate</maml:name> <maml:Description> <maml:para>value of tag base rate</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">double</command:parameterValue> <dev:type> <maml:name>double</maml:name> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {vc-tag-based-rate-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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VcTagBasedRateFactor = Initialize-VcfOpsVcTagBasedRateFactor -Key "MyKey" -Value "MyValue" -Rate 0 -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvctagbasedratefactor with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VcTagBasedRateFactor = Initialize-VcfOpsVcTagBasedRateFactor </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvctagbasedratefactor with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VcTagBasedRateFactor</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsVcenterIntegration</command:name> <command:verb>Initialize</command:verb> <command:noun>VcenterIntegration</command:noun> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating, or updating vCenter integration, with vSAN and Service Discovery configs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating, or updating vCenter integration, with vSAN and Service Discovery configs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsVcenterIntegration</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 existing cloud account integration, must be null at creation</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>Name</maml:name> <maml:Description> <maml:para>The name of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Optional description of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The Collector instance used by this cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>The Collector Group ID to be used for this cloud account integration</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>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>Cloud account integration specific resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>List of new trusted certificates, must be provided upon creation/update of new cloud account integration, for establishing connection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialInstanceId</maml:name> <maml:Description> <maml:para>Credential Instance identifier, for this cloud account integration.</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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of existing cloud account integration, must be null at creation</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>Name</maml:name> <maml:Description> <maml:para>The name of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml: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>Optional description of the cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorId</maml:name> <maml:Description> <maml:para>The Collector instance used by this cloud account integration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorGroupId</maml:name> <maml:Description> <maml:para>The Collector Group ID to be used for this cloud account integration</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>ResourceIdentifiers</maml:name> <maml:Description> <maml:para>Cloud account integration specific resource identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.NameValue></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.NameValue></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Certificates</maml:name> <maml:Description> <maml:para>List of new trusted certificates, must be provided upon creation/update of new cloud account integration, for establishing connection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.Certificate></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.Certificate></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CredentialInstanceId</maml:name> <maml:Description> <maml:para>Credential Instance identifier, for this cloud account integration.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $NameValue = Initialize-VcfOpsNameValue -Name "MyName" -Value "MyValue" $Certificate = Initialize-VcfOpsCertificate -Thumbprint "MyThumbprint" -CertificateDetails "MyCertificateDetails" -_Certificate "My_Certificate" -IssuedTo "MyIssuedTo" -IssuedBy "MyIssuedBy" -Expires "MyExpires" $VcenterIntegration = Initialize-VcfOpsVcenterIntegration -Id "MyId" -Name "MyName" -Description "MyDescription" -CollectorId "MyCollectorId" -CollectorGroupId "MyCollectorGroupId" -ResourceIdentifiers $NameValue -Certificates $Certificate -CredentialInstanceId "MyCredentialInstanceId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVcenterIntegration with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VcenterIntegration = Initialize-VcfOpsVcenterIntegration </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVcenterIntegration with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VcenterIntegration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsvcentertocloudproxy</command:name> <command:verb>Initialize</command:verb> <command:noun>vcentertocloudproxy</command:noun> <maml:description> <maml:para>Represents vc-cp mapping info</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents vc-cp mapping info</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsvcentertocloudproxy</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorUUID</maml:name> <maml:Description> <maml:para>Identifier of the Collector</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>CollectorGroupId</maml:name> <maml:Description> <maml:para>Identifier of the Collector Group</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>VCenterIds</maml:name> <maml:Description> <maml:para>Identifiers of the vCenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<Guid></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>CollectorUUID</maml:name> <maml:Description> <maml:para>Identifier of the Collector</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>CollectorGroupId</maml:name> <maml:Description> <maml:para>Identifier of the Collector Group</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>VCenterIds</maml:name> <maml:Description> <maml:para>Identifiers of the vCenter</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VcenterToCloudProxy = Initialize-VcfOpsVcenterToCloudProxy -CollectorUUID "MyCollectorUUID" -CollectorGroupId "MyCollectorGroupId" -VCenterIds "MyVCenterIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcentertocloudproxy with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VcenterToCloudProxy = Initialize-VcfOpsVcenterToCloudProxy -VCenterIds "MyVCenterIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcentertocloudproxy with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VcenterToCloudProxy</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsvcentertocloudproxylist</command:name> <command:verb>Initialize</command:verb> <command:noun>vcentertocloudproxylist</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-VcfOpsvcentertocloudproxylist</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VCenterMappings</maml:name> <maml:Description> <maml:para>Collection of vCenter Mapping instances</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxy></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxy></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VCenterMappings</maml:name> <maml:Description> <maml:para>Collection of vCenter Mapping instances</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxy></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.VcenterToCloudProxy></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VcenterToCloudProxy = Initialize-VcfOpsVcenterToCloudProxy -CollectorUUID "MyCollectorUUID" -CollectorGroupId "MyCollectorGroupId" -VCenterIds "MyVCenterIds" $VcenterToCloudProxyList = Initialize-VcfOpsVcenterToCloudProxyList -VCenterMappings $VcenterToCloudProxy </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcentertocloudproxylist with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VcenterToCloudProxy = Initialize-VcfOpsVcenterToCloudProxy -VCenterIds "MyVCenterIds" $VcenterToCloudProxyList = Initialize-VcfOpsVcenterToCloudProxyList -VCenterMappings $VcenterToCloudProxy </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcentertocloudproxylist with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VcenterToCloudProxyList</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsvcentertocloudproxyquery</command:name> <command:verb>Initialize</command:verb> <command:noun>vcentertocloudproxyquery</command:noun> <maml:description> <maml:para>Object used to request vCenter Mappings on a collection of collectors or collectorGroups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Object used to request vCenter Mappings on a collection of collectors or collectorGroups</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsvcentertocloudproxyquery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>CollectorUUIDs</maml:name> <maml:Description> <maml:para>Collection of collectors identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>CollectorGroupIds</maml:name> <maml:Description> <maml:para>Collection of collectorGroups identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>VCenterIds</maml:name> <maml:Description> <maml:para>Collection of vCenters identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<Guid></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>CollectorUUIDs</maml:name> <maml:Description> <maml:para>Collection of collectors identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>CollectorGroupIds</maml:name> <maml:Description> <maml:para>Collection of collectorGroups identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>VCenterIds</maml:name> <maml:Description> <maml:para>Collection of vCenters identifiers</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VcenterToCloudProxyQuery = Initialize-VcfOpsVcenterToCloudProxyQuery -CollectorUUIDs "MyCollectorUUIDs" -CollectorGroupIds "MyCollectorGroupIds" -VCenterIds "MyVCenterIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcentertocloudproxyquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VcenterToCloudProxyQuery = Initialize-VcfOpsVcenterToCloudProxyQuery </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsvcentertocloudproxyquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VcenterToCloudProxyQuery</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsVsanConfig</command:name> <command:verb>Initialize</command:verb> <command:noun>VsanConfig</command:noun> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating or updating, vCenter vSAN Adapter Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A model that serves as the structure of the payload data for creating or updating, vCenter vSAN Adapter Instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsVsanConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SmartDataCollectionEnabled</maml:name> <maml:Description> <maml:para>Enable Smart Data Collection flag, disabled by default</maml:para> </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>Enabled</maml:name> <maml:Description> <maml:para>Enable vSAN flag, disabled by default</maml:para> </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>Id</maml:name> <maml:Description> <maml:para>Identifier of this vSAN adapter, automatically assigned by the system on create. Must be set in case of update</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>AlternateCredentialsId</maml:name> <maml:Description> <maml:para>Alternate credentials id for vSAN adapter. If not set will reuse vCenter credentials instead</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="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SmartDataCollectionEnabled</maml:name> <maml:Description> <maml:para>Enable Smart Data Collection flag, disabled by default</maml:para> </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>Enabled</maml:name> <maml:Description> <maml:para>Enable vSAN flag, disabled by default</maml:para> </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>Id</maml:name> <maml:Description> <maml:para>Identifier of this vSAN adapter, automatically assigned by the system on create. Must be set in case of update</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>AlternateCredentialsId</maml:name> <maml:Description> <maml:para>Alternate credentials id for vSAN adapter. If not set will reuse vCenter credentials instead</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VsanConfig = Initialize-VcfOpsVsanConfig -SmartDataCollectionEnabled $false -Enabled $false -Id "MyId" -AlternateCredentialsId "MyAlternateCredentialsId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVsanConfig with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VsanConfig = Initialize-VcfOpsVsanConfig </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsVsanConfig with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/VsanConfig</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpswebhooktemplate</command:name> <command:verb>Initialize</command:verb> <command:noun>webhooktemplate</command:noun> <maml:description> <maml:para>Model that represents a webhook template. Either both of the updatedAlertRequestConfig and canceledAlertRequestConfig fields should be provided or neither of them. If those fields are not provided, the value of newAlertRequestConfig will be used while sending the notification.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model that represents a webhook template. Either both of the updatedAlertRequestConfig and canceledAlertRequestConfig fields should be provided or neither of them. If those fields are not provided, the value of newAlertRequestConfig will be used while sending the notification.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpswebhooktemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {WEBHOOK_TEMPLATE, EMAIL_TEMPLATE}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml: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>Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {WEBHOOK_TEMPLATE, EMAIL_TEMPLATE}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$WebhookTemplate = Initialize-VcfOpsWebhookTemplate -Type "MyType" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpswebhooktemplate with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$WebhookTemplate = Initialize-VcfOpsWebhookTemplate </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpswebhooktemplate with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/WebhookTemplate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpswlphistoryquery</command:name> <command:verb>Initialize</command:verb> <command:noun>wlphistoryquery</command:noun> <maml:description> <maml:para>Represents criteria of wlp history query.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents criteria of wlp history query.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpswlphistoryquery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StartTime</maml:name> <maml:Description> <maml:para>Start time for history. If not specified, the day prior to the endTime is used.</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>EndTime</maml:name> <maml:Description> <maml:para>End time for history. If not specified, the current time is used.</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>ResourceIds</maml:name> <maml:Description> <maml:para>Currently only one Resource Id can be provided. Support for multiple ids is not available.<br>The id can belong to a Datacenter, CustomDatacenter or a CloudZone for which Workload Rebalance has been performed.<br>If not specified, all such resources are taken into consideration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<Guid></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>StartTime</maml:name> <maml:Description> <maml:para>Start time for history. If not specified, the day prior to the endTime is used.</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>EndTime</maml:name> <maml:Description> <maml:para>End time for history. If not specified, the current time is used.</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>ResourceIds</maml:name> <maml:Description> <maml:para>Currently only one Resource Id can be provided. Support for multiple ids is not available.<br>The id can belong to a Datacenter, CustomDatacenter or a CloudZone for which Workload Rebalance has been performed.<br>If not specified, all such resources are taken into consideration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<Guid></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$WlpHistoryQuery = Initialize-VcfOpsWlpHistoryQuery -StartTime 0 -EndTime 0 -ResourceIds "MyResourceIds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpswlphistoryquery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$WlpHistoryQuery = Initialize-VcfOpsWlpHistoryQuery </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpswlphistoryquery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/WlpHistoryQuery</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsworkloadautomationsettings</command:name> <command:verb>Initialize</command:verb> <command:noun>workloadautomationsettings</command:noun> <maml:description> <maml:para>Model representing Workload Automation settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing Workload Automation settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsworkloadautomationsettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>WorkloadOptimization</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.WorkloadOptimizationSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.WorkloadOptimizationSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterHeadroom</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ClusterHeadroomSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ClusterHeadroomSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChangeDatastore</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ChangeDatastoreSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ChangeDatastoreSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetNetwork</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TargetNetworkSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TargetNetworkSettings</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>WorkloadOptimization</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.WorkloadOptimizationSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.WorkloadOptimizationSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterHeadroom</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ClusterHeadroomSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ClusterHeadroomSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ChangeDatastore</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.ChangeDatastoreSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.ChangeDatastoreSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetNetwork</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.TargetNetworkSettings</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.TargetNetworkSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $WorkloadOptimizationSettings = Initialize-VcfOpsWorkloadOptimizationSettings -PolicyId "MyPolicyId" -Inherited $false $ClusterHeadroomSettings = Initialize-VcfOpsClusterHeadroomSettings -PolicyId "MyPolicyId" -Inherited $false $ChangeDatastoreSettings = Initialize-VcfOpsChangeDatastoreSettings -PolicyId "MyPolicyId" -Inherited $false $TargetNetworkSettings = Initialize-VcfOpsTargetNetworkSettings -PolicyId "MyPolicyId" -Inherited $false $WorkloadAutomationSettings = Initialize-VcfOpsWorkloadAutomationSettings -WorkloadOptimization $WorkloadOptimizationSettings -ClusterHeadroom $ClusterHeadroomSettings -ChangeDatastore $ChangeDatastoreSettings -TargetNetwork $TargetNetworkSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsworkloadautomationsettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $WorkloadAutomationSettings = Initialize-VcfOpsWorkloadAutomationSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsworkloadautomationsettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/WorkloadAutomationSettings</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsworkloadoptimizationsettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpsclusterheadroomsettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpschangedatastoresettings</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VcfOpstargetnetworksettings</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-VcfOpsworkloadoptimizationsettings</command:name> <command:verb>Initialize</command:verb> <command:noun>workloadoptimizationsettings</command:noun> <maml:description> <maml:para>Model representing workload optimization settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Model representing workload optimization settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsworkloadoptimizationsettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>PolicyId</maml:name> <maml:Description> <maml:para>Policy id where policy settings is defined. This field is not supported in Capacity settings and Criticality thresholds.</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>Inherited</maml:name> <maml:Description> <maml:para>Whether policy settings are inherited 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>$WorkloadOptimizationSettings = Initialize-VcfOpsWorkloadOptimizationSettings -PolicyId "MyPolicyId" -Inherited $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsworkloadoptimizationsettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$WorkloadOptimizationSettings = Initialize-VcfOpsWorkloadOptimizationSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsworkloadoptimizationsettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/WorkloadOptimizationSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VcfOpsworkloadplacementsettings</command:name> <command:verb>Initialize</command:verb> <command:noun>workloadplacementsettings</command:noun> <maml:description> <maml:para>Represents the settings for placement</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the settings for placement</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VcfOpsworkloadplacementsettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaggingScope</maml:name> <maml:Description> <maml:para>Tagging Scope</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagGroups</maml:name> <maml:Description> <maml:para>All tag groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TagGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TagGroup></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExcludedClusterTagGroups</maml:name> <maml:Description> <maml:para>Collection of cluster excluded tag groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TagGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TagGroup></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExcludedVmTagGroups</maml:name> <maml:Description> <maml:para>Collection of VM excluded tag groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TagGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TagGroup></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PlacementSettingsEnabled</maml:name> <maml:Description> <maml:para>Turn off placement settings. Criteria defined in 'tagGroups' will no longer be considered for VM placement. By default '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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterExclusionEnabled</maml:name> <maml:Description> <maml:para>Turn off exclusion settings for Cluster. By default '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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmExclusionEnabled</maml:name> <maml:Description> <maml:para>Turn off exclusion settings for VM. By default '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>TaggingScope</maml:name> <maml:Description> <maml:para>Tagging Scope</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vcf.Ops.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vcf.Ops.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TagGroups</maml:name> <maml:Description> <maml:para>All tag groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TagGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TagGroup></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExcludedClusterTagGroups</maml:name> <maml:Description> <maml:para>Collection of cluster excluded tag groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TagGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TagGroup></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ExcludedVmTagGroups</maml:name> <maml:Description> <maml:para>Collection of VM excluded tag groups</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vcf.Ops.Model.TagGroup></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vcf.Ops.Model.TagGroup></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PlacementSettingsEnabled</maml:name> <maml:Description> <maml:para>Turn off placement settings. Criteria defined in 'tagGroups' will no longer be considered for VM placement. By default '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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ClusterExclusionEnabled</maml:name> <maml:Description> <maml:para>Turn off exclusion settings for Cluster. By default '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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmExclusionEnabled</maml:name> <maml:Description> <maml:para>Turn off exclusion settings for VM. By default '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> $ResourceTag = Initialize-VcfOpsResourceTag -Category "MyCategory" -Name "MyName" $TagGroup = Initialize-VcfOpsTagGroup -Name "MyName" -Prioritized $false -ResourceTags $ResourceTag $WorkloadPlacementSettings = Initialize-VcfOpsWorkloadPlacementSettings -TaggingScope "CLUSTER_BASED" -TagGroups $TagGroup -ExcludedClusterTagGroups $TagGroup -ExcludedVmTagGroups $TagGroup -PlacementSettingsEnabled $false -ClusterExclusionEnabled $false -VmExclusionEnabled $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsworkloadplacementsettings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $WorkloadPlacementSettings = Initialize-VcfOpsWorkloadPlacementSettings </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VcfOpsworkloadplacementsettings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vmware-cloud-foundation/latest/data-structures/WorkloadPlacementSettings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VcfOpsOperation</command:name> <command:verb>Get</command:verb> <command:noun>VcfOpsOperation</command:noun> <maml:description> <maml:para>This cmdlet retrieves the PowerCLI SDK cmdlets that correspond to one or more VcfOps API endpoints.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the PowerCLI SDK cmdlets that correspond to one or more VcfOps API endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VcfOpsOperation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>The HTTP method to match. Can be any of the following "Get", "Head", "Post", "Delete", "Patch", "Put", "Trace", "Options"</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Get</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Head</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Post</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Delete</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Patch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Put</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Trace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Options</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:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path for the API endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the 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="true" pipelineInput="False" position="3" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>The tag in the VcfOps API specification for the target 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>The HTTP method to match. Can be any of the following "Get", "Head", "Post", "Delete", "Patch", "Put", "Trace", "Options"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the 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="true" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path for the API endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="3" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>The tag in the VcfOps API specification for the target 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:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Sdk.OpenApi.Cmdlets.ApiOperation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <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:\> Get-VcfOpsOperation -Path '/api/example/operation1'</dev:code> <dev:remarks> <maml:para>This is an example of how to retrieve the Invoke-* cmdlet which corresponds to /api/example/operation1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-VcfOpsOperation -Path '/api/example/operation1' -Method Post</dev:code> <dev:remarks> <maml:para>This is an example of how to retrieve the Invoke-* cmdlet which corresponds to the Post method on /api/example/operation1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-VcfOpsOperation -Path '/api/example/*' -Method Post</dev:code> <dev:remarks> <maml:para>This is an example of how to retrieve all Invoke-* cmdlets which correspond to the Post methods on all endpoints under /api/example</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-VcfOpsOperation -Path '/api/example/*/operation2'</dev:code> <dev:remarks> <maml:para>This is an example of how to escape dynamic subsections of an API path like entity identifiers. In this example the path contains an identifier that is not in its last segment - /api/example/{id}/operation2</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |